Public Member Functions
	GroupChannelParams ()

GroupChannelParams	AddUser (User user)

GroupChannelParams	AddUsers (List< User > users)

GroupChannelParams	AddUserId (string userId)

GroupChannelParams	AddUserIds (List< string > userIds)

GroupChannelParams	SetSuper (bool isSuper)

GroupChannelParams	SetPublic (bool isPublic)

GroupChannelParams	SetEphemeral (bool isEphemeral)

GroupChannelParams	SetDistinct (bool isDistinct)

GroupChannelParams	SetDiscoverable (bool isDiscoverable)

GroupChannelParams	SetChannelUrl (string channelUrl)

GroupChannelParams	SetName (string name)

GroupChannelParams	SetCoverUrl (string coverImageUrl)

GroupChannelParams	SetData (string data)

GroupChannelParams	SetCustomType (string customType)

GroupChannelParams	SetOperators (List< User > operators)

GroupChannelParams	SetOperatorUserIds (List< string > operatorUserIds)

GroupChannelParams	SetAccessCode (string accessCode)

GroupChannelParams	SetStrict (bool strict)

GroupChannelParams	SetBroadcast (bool broadcast)

GroupChannelParams	SetMessageSurvivalSeconds (int messageSurvivalSeconds)

Public Attributes
List< string >	mUserIds

List< string >	mOperatorUserIds

bool	mIsSuper

bool	mIsPublic

bool	mIsEphemeral

bool	mIsDistinct

bool	mIsDiscoverable

string	mChannelUrl

string	mName

object	mCoverUrlOrImage

string	mData

string	mCustomType

string	mAccessCode

bool	mStrict

bool	isBroadcast

int	messageSurvivalSeconds

Detailed Description

Represents a group channel params. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Since: 3.0.15

Constructor & Destructor Documentation

◆ GroupChannelParams()

SendBird.GroupChannelParams.GroupChannelParams ( )

inline

GroupChannelParams constructor.

Since: 3.0.15

Member Function Documentation

◆ AddUser()

GroupChannelParams SendBird.GroupChannelParams.AddUser ( User user )

inline

Add user. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

user user

Returns: GroupChannelParams

Since: 3.0.15

◆ AddUserId()

GroupChannelParams SendBird.GroupChannelParams.AddUserId ( string userId )

inline

Add user id. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

userId userId

Returns: GroupChannelParams

Since: 3.0.15

◆ AddUserIds()

GroupChannelParams SendBird.GroupChannelParams.AddUserIds ( List< string > userIds )

inline

Add user ids. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

userIds userIds

Returns: GroupChannelParams

Since: 3.0.15

◆ AddUsers()

GroupChannelParams SendBird.GroupChannelParams.AddUsers ( List< User > users )

inline

Add users. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

users users

Returns: GroupChannelParams

Since: 3.0.15

◆ SetAccessCode()

GroupChannelParams SendBird.GroupChannelParams.SetAccessCode ( string accessCode )

inline

Sets access code foreach public group channel. The access code setting is only valid foreach 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(string, GroupChannel.GroupChannelJoinHandler) and GroupChannel#acceptInvitation(string, GroupChannel.GroupChannelAcceptInvitationHandler). To delete the existing access code, pass an empty string as to this and call GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler).

Parameters

accessCode Access code to be set.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetBroadcast()

GroupChannelParams SendBird.GroupChannelParams.SetBroadcast ( bool broadcast )

inline

Sets broadcast mode channel. If broadcast mode is true, then super mode will be true. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

broadcast true if broadcast mode channel.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetChannelUrl()

GroupChannelParams SendBird.GroupChannelParams.SetChannelUrl ( string channelUrl )

inline

Sets channel url. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

channelUrl channel url

Returns: GroupChannelParams

Since: 3.0.15

◆ SetCoverUrl()

GroupChannelParams SendBird.GroupChannelParams.SetCoverUrl ( string coverImageUrl )

inline

Sets cover url. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

coverImageUrl cover image url

Returns: GroupChannelParams

Since: 3.0.15

◆ SetCustomType()

GroupChannelParams SendBird.GroupChannelParams.SetCustomType ( string customType )

inline

Sets custom type. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

customType custom type

Returns: GroupChannelParams

Since: 3.0.15

◆ SetData()

GroupChannelParams SendBird.GroupChannelParams.SetData ( string data )

inline

Sets data. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

data data

Returns: GroupChannelParams

Since: 3.0.15

◆ SetDiscoverable()

GroupChannelParams SendBird.GroupChannelParams.SetDiscoverable ( bool isDiscoverable )

inline

Sets discoverable channel foreach public group channel. It is valid only when setPublic(bool) is set to true. If it is set to false, this channel will not appear in the result of PublicGroupChannelListQuery. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

isDiscoverable true if channel is discoverable in the result of PublicGroupChannelListQuery.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetDistinct()

GroupChannelParams SendBird.GroupChannelParams.SetDistinct ( bool isDistinct )

inline

Sets distinct mode. Distinct mode must be false, if super mode is true. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

isDistinct true if distinct mode channel.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetEphemeral()

GroupChannelParams SendBird.GroupChannelParams.SetEphemeral ( bool isEphemeral )

inline

Sets ephemeral mode channel. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

isEphemeral true if ephemeral mode channel.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetMessageSurvivalSeconds()

GroupChannelParams SendBird.GroupChannelParams.SetMessageSurvivalSeconds ( int messageSurvivalSeconds )

inline

Sets the message survival seconds. GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

messageSurvivalSeconds Time before the message should disappears, in seconds.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetName()

GroupChannelParams SendBird.GroupChannelParams.SetName ( string name )

inline

Sets channel name. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

name	channel name

Returns: GroupChannelParams

Since: 3.0.15

◆ SetOperators()

GroupChannelParams SendBird.GroupChannelParams.SetOperators ( List< User > operators )

inline

Add operators. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

operators operators

Returns: GroupChannelParams

Since: 3.0.15

◆ SetOperatorUserIds()

GroupChannelParams SendBird.GroupChannelParams.SetOperatorUserIds ( List< string > operatorUserIds )

inline

Add operator user ids. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

operatorUserIds operatorUserIds

Returns: GroupChannelParams

Since: 3.0.15

◆ SetPublic()

GroupChannelParams SendBird.GroupChannelParams.SetPublic ( bool isPublic )

inline

Sets public mode channel. Distinct mode must be false, if public mode is true. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler) GroupChannel#updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Parameters

isPublic true if public mode channel.

Returns: GroupChannelParams

Since: 3.0.15

◆ SetStrict()

GroupChannelParams SendBird.GroupChannelParams.SetStrict ( bool strict )

inline

Sets strict mode. When true, the channel creation will be failed if any of the users do not exist. When false, the channel creation will be succeeded even if all the users do not exist. The default value is false. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

strict strict

Returns: GroupChannelParams

Since: 3.0.15

◆ SetSuper()

GroupChannelParams SendBird.GroupChannelParams.SetSuper ( bool isSuper )

inline

Sets super mode channel. Distinct mode must be false, if super mode is true. GroupChannel#createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

Parameters

isSuper true if super mode channel.

Returns: GroupChannelParams

Since: 3.0.15

The documentation for this class was generated from the following file:

SendBird/src/GroupChannelParams.cs

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GroupChannelParams()

Member Function Documentation

◆ AddUser()

◆ AddUserId()

◆ AddUserIds()

◆ AddUsers()

◆ SetAccessCode()

◆ SetBroadcast()

◆ SetChannelUrl()

◆ SetCoverUrl()

◆ SetCustomType()

◆ SetData()

◆ SetDiscoverable()

◆ SetDistinct()

◆ SetEphemeral()

◆ SetMessageSurvivalSeconds()

◆ SetName()

◆ SetOperators()

◆ SetOperatorUserIds()

◆ SetPublic()

◆ SetStrict()

◆ SetSuper()