ChatRoom class

IM Chat Room of RTM Plugin.

Inheritance

Properties

attributes Map?
Custom field, no strict limit, can store any valid data.
no setterinherited
client Client
Which Client that the Conversation belongs to.
finalinherited
createdAt DateTime?
The created date of the Conversation.
no setterinherited
creator String?
The creator of the Conversation.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
The ID of the Conversation, it will never be null.
finalinherited
isMuted bool
Indicates whether the Conversation.client has muted offline notifications about this Conversation.
no setterinherited
isUnique bool
Indicates whether the Conversation is normal and unique. The uniqueness is based on the members when creating.
no setterinherited
lastDeliveredAt DateTime?
The last date of the Message which has been delivered to other Client.
no setterinherited
lastMessage Message?
The last Message in the Conversation.
no setterinherited
lastMessageDate DateTime?
The date of the last Message in the Conversation.
no setterinherited
lastMessageTimestamp int?
The timestamp of the last Message in the Conversation.
no setterinherited
lastReadAt DateTime?
The last date of the Message which has been read by other Client.
no setterinherited
members List?
The members of the Conversation.
no setterinherited
name String?
Custom field, generally use it to show the name of the Conversation.
no setterinherited
rawData Map
The raw data of the Conversation.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
uniqueID String?
If the Conversation.isUnique is true, then it will have a unique-ID.
no setterinherited
unreadMessageCount int
The count of the unread Message for the Conversation.client.
no setterinherited
unreadMessageMentioned bool
Indicates whether the unread Message list contians any message that mentions the Conversation.client.
no setterinherited
updatedAt DateTime?
The last updated date of the Conversation.
no setterinherited

Methods

addMembers({required Set<String> members}) Future<MemberResult>
To add members to the Conversation.
inherited
blockMembers({required Set<String> members}) Future<MemberResult>
To block members from the Conversation.
inherited
call({required String method, required Map arguments}) Future
inherited
countMembers() Future<int>
To get the count of the Conversation.members.
inherited
errorFrom(Map result) RTMException
inherited
fetchReceiptTimestamps() Future<void>
To fetch last receipt timestamps of the Message.
inherited
isFailure(Map result) bool
inherited
join() Future<MemberResult>
To let the Conversation.client join to the Conversation.
inherited
mute() Future<void>
To turn off the offline notifications for Conversation.client about this Conversation.
inherited
muteMembers({required Set<String> members}) Future<MemberResult>
To mute members from the Conversation.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseIsoString(String? isoString) DateTime?
inherited
parseMilliseconds(int? milliseconds) DateTime?
inherited
queryBlockedMembers({int? limit = 50, String? next}) Future<QueryMemberResult>
Get the blocked members in the conversation.
inherited
queryMessage({int? startTimestamp, String? startMessageID, bool? startClosed, int? endTimestamp, String? endMessageID, bool? endClosed, MessageQueryDirection? direction, int? limit = 20, int? type}) Future<List<Message>>
To query the history of the Message which has been sent.
inherited
queryMutedMembers({int? limit = 50, String? next}) Future<QueryMemberResult>
Get the muted members in the conversation.
inherited
quit() Future<MemberResult>
To let the Conversation.client quit from the Conversation.
inherited
read() Future<void>
To read Conversation.lastMessage in the Conversation.
inherited
recallMessage({Message? message, String? messageID, int? messageTimestamp}) Future<RecalledMessage>
To recall a sent Message.
inherited
removeMembers({required Set<String> members}) Future<MemberResult>
To remove members from the Conversation.
inherited
send({required Message message, bool? transient, bool? receipt, bool? will, MessagePriority? priority, Map? pushData}) Future<Message>
To send a Message in the Conversation.
inherited
toString() String
A string representation of this object.
inherited
unblockMembers({required Set<String> members}) Future<MemberResult>
To unblock members from the Conversation.
inherited
unmute() Future<void>
To turn on the offline notifications for Conversation.client about this Conversation.
inherited
unmuteMembers({required Set<String> members}) Future<MemberResult>
To unmute members from the Conversation.
inherited
updateInfo({required Map<String, dynamic> attributes}) Future<void>
To update attributes of the Conversation.
inherited
updateMessage({Message? oldMessage, String? oldMessageID, int? oldMessageTimestamp, required Message newMessage}) Future<Message>
To update content of a sent Message.
inherited

Operators

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