GroupChannelParams class Null safety
An object consists a set of parameters to create/update group channel.
- Annotations
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.
read / write
- channelUrl ↔ String?
-
An unique identification for channel. Use in creation only.
read / write
- coverImage ↔ FileInfo?
-
read / write
- customType ↔ String?
-
Custom type for a channel
read / write
- data ↔ String?
-
Custom data for a channel
read / write
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- isBroadcast ↔ bool?
-
Determine a channel is broadcast channel or not. default is
falseread / write - 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.read / write - isDistinct ↔ bool?
-
Determine a channel is distinct or not.
If
true, the channel which has the same users is returned. default isfalseread / write - isEphemeral ↔ bool?
-
Determine a channel is ephemeral or not. default is
falseread / write - isExclusive ↔ bool?
-
Determines whether the channel is exclusive or not
read / write
- isPublic ↔ bool?
-
Determine a channel is public channel or not. default is
falseread / write - 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 isfalseread / write - isSuper ↔ bool?
-
Determine a channel is super channel or not. default is
falseread / write - name ↔ String?
-
Name for a channel
read / write
-
operatorUserIds
↔ List<
String> ? -
List of user id who are operator
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
userIds
↔ List<
String> ? -
List of user id who will get invited
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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