/ SDKs / JavaScript
SDKs
Chat SDKs JavaScript v4
Chat SDKs JavaScript
Chat SDKs
JavaScript
Version 4

Categorize channels by custom type

Copy link

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 a string, and can be useful in 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 using customType includes categorizing channels into "Personal" or "Work."

To get a channel's custom type, read openChannel.customType for open channels and groupChannel.customType for group channels.

Open channel

Copy link
JavaScriptTypeScript
const params = {
    name: NAME,
    customType: CUSTOM_TYPE,
};
const channel = await sb.openChannel.createChannel(params);

Group channel

Copy link
JavaScriptTypeScript
const params = {
    invitedUserIds: ['James', 'Chris'],
    name: NAME,
    customType: CUSTOM_TYPE,
};
const channel = await sb.groupChannel.createChannel(params);