InterfaceGroupChannelCreateParams

Description

Represents a group channel create params.

interface GroupChannelCreateParams {
    accessCode?: string;
    channelUrl?: string;
    coverImage?: FileCompat;
    coverUrl?: string;
    customType?: string;
    data?: string;
    invitedUserIds?: string[];
    isBroadcast?: boolean;
    isDiscoverable?: boolean;
    isDistinct?: boolean;
    isEphemeral?: boolean;
    isExclusive?: boolean;
    isPublic?: boolean;
    isStrict?: boolean;
    isSuper?: boolean;
    name?: string;
    operatorUserIds?: string[];
}

Properties

accessCode? channelUrl? coverImage? coverUrl? customType? data? invitedUserIds? isBroadcast? isDiscoverable? isDistinct? isEphemeral? isExclusive? isPublic? isStrict? isSuper? name? operatorUserIds?

Properties

OptionalaccessCode

accessCode?: string

The access code for public group channel. The access code setting is only valid for public GroupChannels. Once the access code is set, users have to accept an invitation or join the public GroupChannel with the access code to be a member of the channel. Refer to GroupChannel.join and GroupChannel.acceptInvitation. To delete the existing access code, pass an empty string to call GroupChannel.updateChannel.

OptionalchannelUrl

channelUrl?: string

The channel URL of the channel.

OptionalcoverImage

coverImage?: FileCompat

The cover image of the channel.

OptionalcoverUrl

coverUrl?: string

The cover image's URL of the channel.

OptionalcustomType

customType?: string

The custom type of the channel.

Optionaldata

data?: string

The data of the channel.

OptionalinvitedUserIds

invitedUserIds?: string[]

The user ids of the users of the channel. (default: [])

OptionalisBroadcast

isBroadcast?: boolean

The broadcast mode of the channel. If set to true, then isSuper will also be set to true.

OptionalisDiscoverable

isDiscoverable?: boolean

Whether the channel is a discoverable channel for public group channel. It is valid only when isPublic is set to true. If set to false, this channel will not appear in the result of PublicGroupChannelListQuery.

OptionalisDistinct

isDistinct?: boolean

The distinct mode of the channel. If isSuper is true, then this must be set to false.

OptionalisEphemeral

isEphemeral?: boolean

The ephemeral mode of the channel.

OptionalisExclusive

isExclusive?: boolean

The exclusive mode of the channel. If set to true, then isSuper and isBroadcast will both be set to true.

OptionalisPublic

isPublic?: boolean

The public mode of the channel. If set to true, then isDistinct must be false.

OptionalisStrict

isStrict?: boolean

The strict mode of the channel. If true, the channel creation will fail if any of the users do not exist. If false, the channel creation will succeed even if all the users do not exist. (default: false).

OptionalisSuper

isSuper?: boolean

The super mode of the channel. If set to true, then isDistinct must be false.

Optionalname

name?: string

The name of the channel.

OptionaloperatorUserIds

operatorUserIds?: string[]

The operator user IDs of the channel.

Settings

Member Visibility

On This Page

Properties