Categorize channels by custom type
When creating an open channel or a group channel, you can additionally specify a custom channel type to subclassify channels. This custom type takes on the form of String
, and can be useful when searching or filtering channels.
The Data
and CustomType
properties of a channel object allow you to append information to channels. While both properties can be used flexibly, common examples for CustomType
include categorizing channels as "School" or "Work".
Open channel
To get an open channel's custom type, refer to openChannel.customType
.
SbOpenChannelCreateParams
Property name | Type | Description |
---|---|---|
name | string | Specifies the name of the channel. |
customType | string | Specifies the custom channel type which is used for channel grouping. |
Group channel
To get a group channel's custom type, refer to groupChannel.customType
.
SbGroupChannelCreateParams
Property name | Type | Description |
---|---|---|
name | string | Specifies the name of the channel. |
customType | string | Specifies the custom channel type which is used for channel grouping. |
inUserIds | string | Specifies the list of users. |