GroupChannelParams class
An object consists a set of parameters to create/update group channel.
- Annotations
-
- @JsonSerializable()
Constructors
- GroupChannelParams({bool isUpdate = false})
- Constructor for GroupChannelParams
- GroupChannelParams.withChannel(GroupChannel channel)
Properties
- accessCode ↔ String?
-
A string that allows access to the public group channel.
ONLY use for public group channel.
getter/setter pair
- channelUrl ↔ String?
-
An unique identification for channel. Use in creation only.
getter/setter pair
- coverImage ↔ FileInfo?
-
getter/setter pair
- customType ↔ String?
-
Custom type for a channel
getter/setter pair
- data ↔ String?
-
Custom data for a channel
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isBroadcast ↔ bool?
-
Determine a channel is broadcast channel or not. default is
false
getter/setter pair - isDiscoverable ↔ bool?
-
Determine whether the public group channel is discoverable.
It is only for creating or updating a public group channel.
This property will be ingored if isPublic is
false
.getter/setter pair - isDistinct ↔ bool?
-
Determine a channel is distinct or not.
If
true
, the channel which has the same users is returned. default isfalse
getter/setter pair - isEphemeral ↔ bool?
-
Determine a channel is ephemeral or not. default is
false
getter/setter pair - isExclusive ↔ bool?
-
Determines whether the channel is exclusive or not
getter/setter pair
- isPublic ↔ bool?
-
Determine a channel is public channel or not. default is
false
getter/setter pair - isStrict ↔ bool?
-
Determine whether a channel is strict or not.
If you have two valid users and this property is
true
, then the channel is created successfully with that users. If one valid user, one invalid user, and this property istrue
, you will get an error when creating channel. However, if you have one valid user, one invalid user, and this propety isfalse
, you can create a channel without errors default isfalse
getter/setter pair - isSuper ↔ bool?
-
Determine a channel is super channel or not. default is
false
getter/setter pair - name ↔ String?
-
Name for a channel
getter/setter pair
-
operatorUserIds
↔ List<
String> ? -
List of user id who are operator
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
userIds
↔ List<
String> ? -
List of user id who will get invited
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