GroupChannelCreateParams class

Represents a group channel create params.

Annotations

Constructors

GroupChannelCreateParams()

Properties

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 GroupChannelOperation.join and GroupChannelOperation.acceptInvitation. To delete the existing access code, pass an empty string as to this and call GroupChannel.updateChannel.
read / write
channelUrl String?
The channel url of the channel.
read / write
coverImage FileInfo?
The cover image file info.
read / write
customType String?
The custom type of the channel.
read / write
data String?
The data of the channel.
read / write
hashCode int
The hash code for this object.
read-onlyinherited
isBroadcast bool?
The broadcast mode of the channel. If set to true, then isSuper will be true.
read / write
isDiscoverable bool?
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.
read / write
isDistinct bool?
The distinct mode of the channel. If isSuper is true, then this must be set to false.
read / write
isEphemeral bool?
The ephemeral mode of the channel.
read / write
isExclusive bool?
The exclusive mode of the channel. If set to true, then isSuper and isBroadcast will both be true.
read / write
isPublic bool?
The public mode of the channel. If set to true, then isDistinct must be false.
read / write
isStrict bool?
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.
read / write
isSuper bool?
The super mode of the channel. If set to true, then isDistinct must be false.
read / write
name String?
The name of the channel.
read / write
operatorUserIds List<String>?
The operator user ids of the channel. Defaults to null.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
userIds List<String>?
The user ids of the users of the channel. Defaults to an empty list.
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited