Sendbird Chat SDK for Unity
Properties | List of all members
SbGroupChannelCreateParams

An object contains set of options to create a group channel More...

Properties

string AccessCode [get, set]
 A string that allows access to the public group channel. ONLY use for public group channel. More...
 
string ChannelUrl [get, set]
 Represents the channel is to be updated. More...
 
SbFileInfo CoverImage [get, set]
 The cover image of the channel. Defaults to null. If CoverUrl was set after, this will be reset to null. More...
 
string CoverUrl [get, set]
 The cover image's url of the channel. Defaults to null. If CoverImage was set after, this will be reset to null. More...
 
string CustomType [get, set]
 The custom type of the channel. More...
 
string Data [get, set]
 The data of the channel. More...
 
bool IsBroadcast [get, set]
 The broadcast mode of the channel. If set to true, then IsSuper will be true. More...
 
bool IsDiscoverable [get, set]
 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 SbPublicGroupChannelListQuery. More...
 
bool IsDistinct [get, set]
 The distinct mode of the channel. If IsSuper is true, then this must be set to false. More...
 
bool IsEphemeral [get, set]
 The ephemeral mode of the channel. More...
 
bool IsExclusive [get, set]
 The exclusive mode of the channel. If set to true, then IsSuper and isBroadcast will both be true. More...
 
bool IsPublic [get, set]
 The public mode of the channel. If set to true, then IsDistinct must be false. More...
 
bool IsStrict [get, set]
 The strict mode of the channel. When true, the channel creation will fail if any of the users do not exist. When false, the channel creation will succeed even if all the users do not exist. The default value is false. More...
 
bool IsSuper [get, set]
 The super mode of the channel. If set to true, then IsDistinct must be false. More...
 
int MessageSurvivalSeconds [get, set]
 The message survival seconds of the channel. More...
 
string Name [get, set]
 The name of the channel. More...
 
List< string > OperatorUserIds [get, set]
 The operator user ids of the channel. Defaults to null. More...
 
List< string > UserIds [get, set]
 The user ids of the users of the channel. Defaults to an empty list. More...
 

Detailed Description

An object contains set of options to create a group channel

Since
4.0.0

Property Documentation

◆ AccessCode

string AccessCode
getset

A string that allows access to the public group channel. ONLY use for public group channel.

Since
4.0.0

◆ ChannelUrl

string ChannelUrl
getset

Represents the channel is to be updated.

Since
4.0.0

◆ CoverImage

SbFileInfo CoverImage
getset

The cover image of the channel. Defaults to null. If CoverUrl was set after, this will be reset to null.

Since
4.0.0

◆ CoverUrl

string CoverUrl
getset

The cover image's url of the channel. Defaults to null. If CoverImage was set after, this will be reset to null.

Since
4.0.0

◆ CustomType

string CustomType
getset

The custom type of the channel.

Since
4.0.0

◆ Data

string Data
getset

The data of the channel.

Since
4.0.0

◆ IsBroadcast

bool IsBroadcast
getset

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

Since
4.0.0

◆ IsDiscoverable

bool IsDiscoverable
getset

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 SbPublicGroupChannelListQuery.

Since
4.0.0

◆ IsDistinct

bool IsDistinct
getset

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

Since
4.0.0

◆ IsEphemeral

bool IsEphemeral
getset

The ephemeral mode of the channel.

Since
4.0.0

◆ IsExclusive

bool IsExclusive
getset

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

Since
4.0.0

◆ IsPublic

bool IsPublic
getset

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

Since
4.0.0

◆ IsStrict

bool IsStrict
getset

The strict mode of the channel. When true, the channel creation will fail if any of the users do not exist. When false, the channel creation will succeed even if all the users do not exist. The default value is false.

Since
4.0.0

◆ IsSuper

bool IsSuper
getset

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

Since
4.0.0

◆ MessageSurvivalSeconds

int MessageSurvivalSeconds
getset

The message survival seconds of the channel.

Since
4.0.0

◆ Name

string Name
getset

The name of the channel.

Since
4.0.0

◆ OperatorUserIds

List<string> OperatorUserIds
getset

The operator user ids of the channel. Defaults to null.

Since
4.0.0

◆ UserIds

List<string> UserIds
getset

The user ids of the users of the channel. Defaults to an empty list.

Since
4.0.0