GroupChannel class
Represents a group channel.
- Inheritance
-
- Object
- BaseChannel
- GroupChannel
- Available extensions
- BaseChannelMessage
- BaseChannelMessageMetaArray
- BaseChannelMetaCounters
- BaseChannelMetaData
- BaseChannelModeration
- BaseChannelOperator
- BaseChannelReactions
- GroupChannelConfiguration
- GroupChannelExtensions
- GroupChannelOperation
- GroupChannelPinnedMessage
- GroupChannelPoll
- GroupChannelRead
- GroupChannelScheduledMessage
- GroupChannelTyping
- Annotations
-
- @JsonSerializable()
Constructors
-
GroupChannel.new({required String channelUrl, BaseMessage? lastMessage, bool isSuper = false, bool isBroadcast = false, bool isPublic = false, bool isDistinct = false, bool isDiscoverable = false, bool isExclusive = false, bool isAccessCodeRequired = false, int unreadMessageCount = 0, int unreadMentionCount = 0, List<
Member> members = const [], int memberCount = 0, int joinedMemberCount = 0, GroupChannelPushTriggerOption myPushTriggerOption = GroupChannelPushTriggerOption.defaultValue, bool isChatNotification = false, MemberState myMemberState = MemberState.none, Role myRole = Role.none, MuteState myMutedState = MuteState.unmuted, CountPreference myCountPreference = CountPreference.all, User? creator, Member? inviter, int invitedAt = 0, int joinedAt = 0, bool isHidden = false, int myLastRead = 0, int? messageOffsetTimestamp, int messageSurvivalSeconds = -1, List<int> pinnedMessageIds = const [], BaseMessage? lastPinnedMessage, int pinnedMessageUpdatedAt = 0, int? messageDeletionTimestamp, String name = '', String coverUrl = '', int? createdAt, String data = '', String customType = '', bool isFrozen = false, bool isEphemeral = false}) -
GroupChannel.fromJson(Map<
String, dynamic> json) -
factory
-
GroupChannel.fromJsonWithChat(Chat chat, Map<
String, dynamic> json) -
factory
Properties
- canChangeUnreadMentionCount → bool
-
Available on GroupChannel, provided by the GroupChannelExtensions extension
no setter - canChangeUnreadMessageCount → bool
-
Available on GroupChannel, provided by the GroupChannelExtensions extension
no setter - channelType → ChannelType
-
ChannelType
no setterinherited
- channelUrl ↔ String
-
The unique channel URL.
getter/setter pairinherited
- chat ↔ Chat
-
getter/setter pairinherited
- coverUrl ↔ String
-
The cover image URL.
getter/setter pairinherited
- createdAt ↔ int?
-
The creation time of the channel.
getter/setter pairinherited
- creator ↔ User?
-
The creator of this channel.
getter/setter pair
- customType ↔ String
-
The custom type of the channel.
getter/setter pairinherited
- data ↔ String
-
The channel data.
getter/setter pairinherited
- dirty ↔ bool
-
getter/setter pairinherited
- fromCache ↔ bool
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
-
The hiddenState of this channel.
getter/setter pair
- invitedAt ↔ int
-
My invitation timestamp.
getter/setter pair
- inviter ↔ Member?
-
The inviter of the current User to this channel.
getter/setter pair
- isAccessCodeRequired ↔ bool
-
Whether this channel requires access code to join.
This value is valid only if this channel is a public GroupChannel.
getter/setter pair
- isBroadcast ↔ bool
-
Checks whether this channel is a broadcast GroupChannel.
getter/setter pair
- isChatNotification ↔ bool
-
Checks whether this channel is a chat notification GroupChannel.
@since 4.0.3
getter/setter pair
- isDiscoverable ↔ bool
-
Checks whether this channel is discoverable in the result of PublicGroupChannelListQuery.
If it is false, it will not appear on the result of PublicGroupChannelListQuery.
getter/setter pair
- isDistinct ↔ bool
-
Checks whether this channel is a distinct GroupChannel.
For a distinct GroupChannel, later when you create GroupChannel with same User and isDistinct flag being
true
(refer to createChannel), the channel URL does not change, which means the messages between Users remain at the channel. If the channel is not distinct one, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.getter/setter pair - isEphemeral ↔ bool
-
Whether the channel is ephemeral.
getter/setter pairinherited
- isExclusive ↔ bool
-
Checks whether this channel is an exclusive GroupChannel.
getter/setter pair
- isFrozen ↔ bool
-
Whether the channel is frozen.
getter/setter pairinherited
- isHidden ↔ bool
-
Checks whether this channel is hidden.
getter/setter pair
- isPublic ↔ bool
-
Checks whether this channel is a public GroupChannel.
getter/setter pair
- isSuper ↔ bool
-
Checks whether this channel is a super GroupChannel.
getter/setter pair
- isTyping → bool
-
Available on GroupChannel, provided by the GroupChannelTyping extension
Whether one or more members are typing.no setter - joinedAt ↔ int
-
The timestamp when the current user joined.
getter/setter pair
- joinedMemberCount ↔ int
-
The total joined member count for this channel.
getter/setter pair
- key → String
-
no setterinherited
- lastMessage ↔ BaseMessage?
-
The last message of the channel.
getter/setter pair
- lastPinnedMessage ↔ BaseMessage?
-
The last message among channel's pinned messages.
getter/setter pair
- memberCount ↔ int
-
The total member count for this channel.
getter/setter pair
-
members
↔ List<
Member> -
Member list for this channel.
getter/setter pair
- messageDeletionTimestamp ↔ int?
-
Message deletion cutoff timestamp.
@since 4.2.31
getter/setter pair
- messageOffsetTimestamp ↔ int?
-
This property is set when GroupChannelOperation.resetMyHistory and GroupChannelConfiguration.hide is called.
getter/setter pair
- messageSurvivalSeconds ↔ int
-
getter/setter pair
- myCountPreference ↔ CountPreference
-
Checks whether unread message count is enabled for this channel.
This count preference can be set by GroupChannelConfiguration.setMyCountPreference.
getter/setter pair
- myLastRead ↔ int
-
Current user's last read receipt timestamp in channel.
getter/setter pair
- myMemberState ↔ MemberState
-
My member state.
getter/setter pair
- myMutedState ↔ MuteState
-
My muted state in this channel.
getter/setter pair
- myPushTriggerOption ↔ GroupChannelPushTriggerOption
-
My push trigger option.
The push trigger setting can be updated by GroupChannelConfiguration.setMyPushTriggerOption.
getter/setter pair
- myRole ↔ Role
-
My Role in this channel.
getter/setter pair
- name ↔ String
-
The topic or name of the channel.
getter/setter pairinherited
-
pinnedMessageIds
↔ List<
int> -
The pinned message ids of the channel.
getter/setter pair
- pinnedMessageUpdatedAt ↔ int
-
getter/setter pair
- primaryKey → String
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unreadMentionCount ↔ int
-
The unread mention count for this channel for the current User.
getter/setter pair
- unreadMessageCount ↔ int
-
The unread message count for this channel for the current User.
getter/setter pair
Methods
-
acceptInvitation(
{String? accessCode}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
Accepts the invitation sent to the currentUser
. After the acceptance, theUser
will be joined to thisGroupChannel
. -
addMember(
Member? newMember) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
addMessageMetaArrayValues(
BaseMessage message, List< MessageMetaArray> metaArrays) → Future<BaseMessage> -
Available on BaseChannel, provided by the BaseChannelMessageMetaArray extension
Adds message meta array values. -
addOperators(
List< String> userIds) → Future<void> -
Available on BaseChannel, provided by the BaseChannelOperator extension
Add operators to the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators. -
addPollOption(
{required int pollId, required String optionText}) → Future< Poll> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Adds an option withoptionText
to this poll. -
addReaction(
BaseMessage message, String key) → Future< ReactionEvent> -
Available on BaseChannel, provided by the BaseChannelReactions extension
AddsReaction
. -
banUser(
{required String userId, int seconds = -1, String? description}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
Bans a user. Operators can ban users from this channel. Banned user is kicked out of this channel and cannot enter during the specified seconds. If you want to ban the user indefinitely, pass -1 to seconds as the argument. -
cancelFileMessageUpload(
String requestId) → bool -
Available on BaseChannel, provided by the BaseChannelMessage extension
Cancels an ongoingFileMessage
upload. -
cancelScheduledMessage(
{required int scheduledMessageId}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Cancels a scheduled message with scheduledMessageId. -
canUpdate(
GroupChannel channel) → Future< bool> -
checkUnsupportedAction(
) → void -
inherited
-
clearUnreadCount(
) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
closePoll(
{required int pollId}) → Future< Poll> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Closes this poll. -
copyMessage(
BaseMessage message, BaseChannel targetChannel, {BaseMessageHandler? handler}) → BaseMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Copies a message from this channel to the target channel. -
copyWith(
dynamic other) → void -
override
-
createMessageMetaArrayKeys(
BaseMessage message, List< String> keys) → Future<BaseMessage> -
Available on BaseChannel, provided by the BaseChannelMessageMetaArray extension
Creates message meta array keys. -
createMetaCounters(
Map< String, int> metaCounters) → Future<Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Creates meta counters. This can be used to customize the channel. -
createMetaData(
Map< String, String> metaData) → Future<Map< String, String> > -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Creates meta data. This can be used to customize the channel. -
createScheduledFileMessage(
ScheduledFileMessageCreateParams params) → Future< FileMessage> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Creates a file message to be sent at the specified time. -
createScheduledUserMessage(
ScheduledUserMessageCreateParams params) → Future< UserMessage> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Creates a user message to be sent at the specified time. -
declineInvitation(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
Declines the invitation sent to the currentUser
. -
decreaseMetaCounters(
Map< String, int> metaCounters) → Future<Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Decreases meta counters. This decreases atomically the keyed meta counter by the specified value. -
deleteAllMetaCounters(
) → Future< void> -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Deletes all meta counters. -
deleteAllMetaData(
) → Future< void> -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Deletes all meta data. -
deleteChannel(
) → Future< void> -
Deletes this
GroupChannel
. Note that only operators of a channel are able to delete it or else, an error will be returned to the handler. -
deleteMessage(
int messageId) → Future< void> -
Available on BaseChannel, provided by the BaseChannelMessage extension
Deletes a message. -
deleteMessageMetaArrayKeys(
BaseMessage message, List< String> keys) → Future<BaseMessage> -
Available on BaseChannel, provided by the BaseChannelMessageMetaArray extension
Deletes message meta array keys. -
deleteMetaCounters(
String key) → Future< void> -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Deletes a meta counter. -
deleteMetaData(
String key) → Future< void> -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Deletes a meta data. -
deletePoll(
{required int pollId}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Deletes this poll. -
deletePollOption(
{required int pollId, required int pollOptionId}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Deletes this poll option. -
deleteReaction(
BaseMessage message, String key) → Future< ReactionEvent> -
Available on BaseChannel, provided by the BaseChannelReactions extension
DeletesReaction
. -
endTyping(
) → void -
Available on GroupChannel, provided by the GroupChannelTyping extension
Sends end typing event. -
freeze(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Freeze thisGroupChannel
. -
getAllMetaCounters(
) → Future< Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Get all meta counters. -
getAllMetaData(
) → Future< Map< String, String> > -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Gets all meta data. -
getCachedDeliveryStatus(
String channelUrl) → Map< String, int> -
getCachedMetaData(
) → Map< String, String> -
Available on BaseChannel, provided by the BaseChannelMetaData extension
All locally cached metadata as a map. Cached metadata is updated under following circumstances: -
getCachedReadStatus(
String channelUrl) → Map< String, int> -
getMember(
String userId) → Member? -
getMessageChangeLogs(
MessageChangeLogParams params, {int? timestamp, String? token}) → Future< MessageChangeLogs> -
Available on BaseChannel, provided by the BaseChannelMessage extension
Requests message change logs after given token or timestamp -
getMessageDeletionTimestamp(
{Chat? chat}) → Future< int?> -
getMessagesByMessageId(
int messageId, MessageListParams params) → Future< List< RootMessage> > -
Available on BaseChannel, provided by the BaseChannelMessage extension
Retrieves previous or next messages based on the message ID in a specific channel. -
getMessagesByTimestamp(
int timestamp, MessageListParams params) → Future< List< RootMessage> > -
Available on BaseChannel, provided by the BaseChannelMessage extension
Retrieves previous or next messages based on the timestamp in a specific channel. -
getMetaCounters(
List< String> keys) → Future<Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Gets meta counters. -
getMetaData(
List< String> keys) → Future<Map< String, String> > -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Gets meta data. -
getMyMuteInfo(
) → Future< MuteInfo> -
Available on BaseChannel, provided by the BaseChannelModeration extension
Gets my muted information in this channel. -
getMyPushTriggerOption(
) → Future< GroupChannelPushTriggerOption> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Gets push trigger option of this channel. Refer to PushTriggerOption. For details of push trigger option, refer to setMyPushTriggerOption -
getPollChangeLogsSinceTimestamp(
int timestamp) → Future< PollChangeLogs> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Requests poll change logs after given timestamp. -
getPollChangeLogsSinceToken(
String? token) → Future< PollChangeLogs> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Requests poll change logs after given token. -
getReadMembers(
BaseMessage message, {bool includeAllMembers = false}) → List< Member> -
Available on GroupChannel, provided by the GroupChannelRead extension
Gets the member list who have read the given message. -
getReadStatus(
bool includeAllMembers) → Map< String, Map< String, dynamic> > -
Available on GroupChannel, provided by the GroupChannelRead extension
GetsReadStatus
for all members in this GroupChannel. -
getTypingUsers(
) → List< User> -
Available on GroupChannel, provided by the GroupChannelTyping extension
The typing user list. -
getUndeliveredMembers(
BaseMessage message) → List< Member> ? -
Available on GroupChannel, provided by the GroupChannelRead extension
Returns the list of members that haven't received the given message. This excludes the current logged-in User and the Sender of the message. It will always be zero if the passed on message is an AdminMessage, or if this channel is a super group channel. If there is no delivery status, returns null. (Delivery receipt is a premium feature.) -
getUnreadMembers(
BaseMessage message, {bool includeAllMembers = false}) → List< Member> -
Available on GroupChannel, provided by the GroupChannelRead extension
Gets the member list who haven't read the given message. -
hide(
{bool hidePreviousMessage = false, bool allowAutoUnhide = true}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Hides this channel from the currentUser's
GroupChannel` list. When a new message is received from the channel, it appears again. -
increaseMetaCounters(
Map< String, int> metaCounters) → Future<Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Increases meta counters. This increases atomically the keyed meta counter by the specified value. -
increaseUnreadMentionCount(
) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
invite(
List< String> userIds) → Future<void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
InvitesUser
s top this channel. -
join(
{String? accessCode}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
Joins this channel if this channel is public. -
leave(
{bool? shouldRemoveOperatorStatus}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
Leaves this channel. SetshouldRemoveOperatorStatus
to true if you want to remove the operator status. -
markAsRead(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelRead extension
Sends mark as read to this channel. -
muteUser(
{required String userId, int seconds = -1, String? description}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
MutesUser
. MutedUser
's messages are no longer delivered to currentUser
. -
myReadReceipt(
) → int -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyScreenshotWasTaken(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Notifies the current user took a screenshot in this channel. The server is going to send an admin message to notify this in the group channel. -
pinMessage(
int messageId) → Future< void> -
Available on GroupChannel, provided by the GroupChannelPinnedMessage extension
Pins a message to the channel.messageId
is id of a message to pin. -
removeAllOperators(
) → Future< void> -
Available on BaseChannel, provided by the BaseChannelOperator extension
Remove all operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators. -
removeMember(
String? userId) → Member? -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
removeMessageMetaArrayValues(
BaseMessage message, List< MessageMetaArray> metaArrays) → Future<BaseMessage> -
Available on BaseChannel, provided by the BaseChannelMessageMetaArray extension
Removes message meta array values. -
removeOperators(
List< String> userIds) → Future<void> -
Available on BaseChannel, provided by the BaseChannelOperator extension
Remove operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators. -
report(
{required ReportCategory category, String? description}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
Reports this channel of inappropriate activities. -
reportMessage(
{required BaseMessage message, required ReportCategory category, String? description}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
Reports a malicious message. -
reportUser(
{required String userId, required ReportCategory category, String? description}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
Reports a user of suspicious activities. -
resendFileMessage(
FileMessage message, {File? file, FileMessageHandler? handler, ProgressHandler? progressHandler}) → FileMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Resends a file with given file information.fileMessage
Failed fileMessage.file
File to resend. If there is a fileUrl or a fileBytes in fileMessage, this will be ignored. -
resendUserMessage(
UserMessage message, {UserMessageHandler? handler}) → UserMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Resends a failed user message.message
is a failed user message. -
resetMyHistory(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelOperation extension
Resets the chat history of this channel for the current User. After this call, the messages created before the call will not be loaded. -
sendFileMessage(
FileMessageCreateParams params, {FileMessageHandler? handler, ProgressHandler? progressHandler, int? resendMessageId}) → FileMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Sends a file with given file information. -
sendScheduledMessageNow(
{required int scheduledMessageId}) → Future< void> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Sends a scheduled message now. -
sendUserMessage(
UserMessageCreateParams params, {UserMessageHandler? handler, int? resendMessageId}) → UserMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Sends a user message. -
sendUserMessageWithText(
String text, {UserMessageHandler? handler}) → UserMessage -
Available on BaseChannel, provided by the BaseChannelMessage extension
Sends a user message with text. -
serialize(
) → Uint8List -
inherited
-
set(
Chat chat) → void -
inherited
-
setBlockedByMe(
{required String targetId, required bool blocked}) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
setCachedDeliveryStatus(
Map< String, int> deliveryStatus) → void -
setCachedMetaData(
Map< String, String> metaData) → void -
Available on BaseChannel, provided by the BaseChannelMetaData extension
-
setCachedReadStatus(
Map< String, int> readStatus) → void -
setMyCountPreference(
CountPreference countPreference) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Sets my count preference for this channel. -
setMyPushTriggerOption(
GroupChannelPushTriggerOption option) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Sets push trigger option of this channel. If channel's push trigger option is set to GroupChannelPushTriggerOption.defaultValue, it works according to the state of PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannelPushTriggerOption. -
shouldUpdateLastMessage(
BaseMessage message, Sender? sender) → bool -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
startTyping(
) → void -
Available on GroupChannel, provided by the GroupChannelTyping extension
Sends start typing event. -
toJson(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
-
translateUserMessage(
UserMessage message, List< String> targetLanguages) → Future<UserMessage> -
Available on BaseChannel, provided by the BaseChannelMessage extension
Translates a user message. -
unbanUser(
{required String userId}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
UnbansUser
. Operators can unbanUser
who has been banned from this channel. -
unfreeze(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Unfreeze thisGroupChannel
. -
unhide(
) → Future< void> -
Available on GroupChannel, provided by the GroupChannelConfiguration extension
Unhides this channel from the currentUser
'sGroupChannel
list. -
unmuteUser(
{required String userId}) → Future< void> -
Available on BaseChannel, provided by the BaseChannelModeration extension
UnmutesUser
. UnmutedUser
's messages are again shown to currentUser
. -
unpinMessage(
int messageId) → Future< void> -
Available on GroupChannel, provided by the GroupChannelPinnedMessage extension
Removes the message from the channel's pinned messages.messageId
is id of a message to unpin. -
updateChannel(
GroupChannelUpdateParams params, {ProgressHandler? progressHandler}) → Future< GroupChannel> - Update this channel with GroupChannelUpdateParams.
-
updateFileMessage(
int messageId, FileMessageUpdateParams params) → Future< FileMessage> -
Available on BaseChannel, provided by the BaseChannelMessage extension
Updates aFileMessage
that was previously sent in the channel. Note that the file itself cannot be changed; only the fields stored within the message can be modified. -
updateMember(
User? user) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
updateMemberCounts(
ChannelEvent event) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
updateMetaCounters(
Map< String, int> metaCounters) → Future<Map< String, int> > -
Available on BaseChannel, provided by the BaseChannelMetaCounters extension
Updates meta counters. -
updateMetaData(
Map< String, String> metaData) → Future<Map< String, String> > -
Available on BaseChannel, provided by the BaseChannelMetaData extension
Updates meta data. -
updatePoll(
{required int pollId, required PollUpdateParams params}) → Future< Poll> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Updates fields of this poll with givenparams
. -
updatePollOption(
{required int pollId, required int pollOptionId, required String optionText}) → Future< Poll> -
Available on GroupChannel, provided by the GroupChannelPoll extension
UpdatesoptionText
fields of this poll option. -
updateScheduledFileMessage(
{required ScheduledFileMessageUpdateParams params, required int scheduledMessageId}) → Future< FileMessage> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Update a scheduled file message with scheduledMessageId and ScheduledFileMessageUpdateParams. -
updateScheduledUserMessage(
{required ScheduledUserMessageUpdateParams params, required int scheduledMessageId}) → Future< UserMessage> -
Available on GroupChannel, provided by the GroupChannelScheduledMessage extension
Update a scheduled user message with scheduledMessageId and ScheduledUserMessageUpdateParams. -
updateTypingStatus(
Member? member, {bool typing = false}) → void -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
updateUnreadCount(
RootMessage message) → bool -
Available on GroupChannel, provided by the GroupChannelExtensions extension
-
updateUserMessage(
int messageId, UserMessageUpdateParams params) → Future< UserMessage> -
Available on BaseChannel, provided by the BaseChannelMessage extension
Updates aUserMessage
that was previously sent in the channel. -
votePoll(
{required int pollId, required List< int> pollOptionIds}) → Future<PollVoteEvent> -
Available on GroupChannel, provided by the GroupChannelPoll extension
Vote onpollOptionIds
. This operation overrides previous vote actions, so to update previous vote, pass newpollOptionIds
as parameter. To cancel votes, pass an empty list aspollOptionIds
.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Static Methods
-
createChannel(
GroupChannelCreateParams params, {ProgressHandler? progressHandler, Chat? chat}) → Future< GroupChannel> -
Creates
GroupChannel
with GroupChannelCreateParams. -
getChannel(
String channelUrl, {Chat? chat}) → Future< GroupChannel> -
Gets a
GroupChannel
with given channel URL. -
getChannelFromCache(
String channelUrl, {Chat? chat}) → Future< GroupChannel?> -
Gets a
GroupChannel
with given channel URL from cache. -
refresh(
String channelUrl, {Chat? chat}) → Future< GroupChannel> - Refreshes all the data of this channel.