GroupChannelCreateParams class

Represents a group channel create params.

Annotations

• @JsonSerializable()

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.

getter/setter pair

channelUrl ↔ String?

The channel url of the channel.

getter/setter pair

coverImage ↔ FileInfo?

The cover image file info.

getter/setter pair

customType ↔ String?

The custom type of the channel.

getter/setter pair

data ↔ String?

The data of the channel.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isBroadcast ↔ bool?

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

getter/setter pair

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.

getter/setter pair

isDistinct ↔ bool?

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

getter/setter pair

isEphemeral ↔ bool?

The ephemeral mode of the channel.

getter/setter pair

isExclusive ↔ bool?

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

getter/setter pair

isPublic ↔ bool?

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

getter/setter pair

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.

getter/setter pair

isSuper ↔ bool?

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

getter/setter pair

name ↔ String?

The name of the channel.

getter/setter pair

operatorUserIds ↔ List<String>?

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userIds ↔ List<String>?

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

getter/setter pair

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

Static Methods

fromJson(Map<String, dynamic> json) → GroupChannelCreateParams