GroupChannelCreateParams

Represents a group channel create params.

Since

3.0.49

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

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 as to this and call GroupChannel.updateChannel.

Link copied to clipboard

The channel url of the channel.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The custom type of the channel.

Link copied to clipboard
var data: String?

The data of the channel.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The ephemeral mode of the channel.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The message survival seconds of the channel.

Link copied to clipboard
var name: String?

The name of the channel.

Link copied to clipboard

The operator users of the channel. Defaults to null. If operatorUserIds is set after, this will be invalidated.

Link copied to clipboard

The operator user ids of the channel. Defaults to null. If operators is set after, this will be invalidated.

Link copied to clipboard

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.

Link copied to clipboard

The user ids of the users of the channel. Defaults to an empty list. If users is set after, this will be invalidated.

Link copied to clipboard

The user ids of the users of the channel. Defaults to an empty list. If userIds is set after, this will be invalidated.

Functions

Link copied to clipboard

Clones and returns a new instance of given GroupChannelCreateParams.

Link copied to clipboard
fun copy(coverUrl: String? = this.coverUrl, coverImage: File? = this.coverImage, userIds: List<String> = this.userIds, users: List<User> = this.users, operatorUserIds: List<String>? = this.operatorUserIds, operators: List<User>? = this.operators, isSuper: Boolean? = this.isSuper, isBroadcast: Boolean? = this.isBroadcast, isExclusive: Boolean? = this.isExclusive, isPublic: Boolean? = this.isPublic, isEphemeral: Boolean? = this.isEphemeral, isDistinct: Boolean? = this.isDistinct, isDiscoverable: Boolean? = this.isDiscoverable, channelUrl: String? = this.channelUrl, name: String? = this.name, data: String? = this.data, customType: String? = this.customType, accessCode: String? = this.accessCode, strict: Boolean? = this.strict, messageSurvivalSeconds: Int? = this.messageSurvivalSeconds): GroupChannelCreateParams
Link copied to clipboard
open override fun toString(): String