Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove ID being mandatory when creating segments #1227

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2952,15 +2952,13 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
*
* @private
* @param {SegmentType} type Segment type
* @param {string} id Segment ID (valid UUID)
* @param {string} name Segment name (valid UUID)
* @param {SegmentData} params Segment data
*
* @return {Segment} The created Segment
*/
private async createSegment(type: SegmentType, id: string, name: string, data?: SegmentData): Promise<Segment> {
private async createSegment(type: SegmentType, name: string, data?: SegmentData): Promise<Segment> {
const body = {
id,
type,
name,
data,
Expand All @@ -2972,27 +2970,25 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
/**
* createUserSegment - Creates a user segment
*
* @param {string} id Segment ID (valid UUID)
* @param {string} name Segment name
* @param {SegmentData} data Segment data
*
* @return {Segment} The created Segment
*/
async createUserSegment(id: string, name: string, data?: SegmentData): Promise<Segment> {
return await this.createSegment('user', id, name, data);
async createUserSegment(name: string, data?: SegmentData): Promise<Segment> {
return await this.createSegment('user', name, data);
}

/**
* createChannelSegment - Creates a channel segment
*
* @param {string} id Segment ID (valid UUID)
* @param {string} name Segment name
* @param {SegmentData} data Segment data
*
* @return {Segment} The created Segment
*/
async createChannelSegment(id: string, name: string, data?: SegmentData): Promise<Segment> {
return await this.createSegment('channel', id, name, data);
async createChannelSegment(name: string, data?: SegmentData): Promise<Segment> {
return await this.createSegment('channel', name, data);
}

/**
Expand Down
Loading