StringeeConversation class

A Stringee direct, group, live-chat, or OA conversation.

Constructors

StringeeConversation.fromJson(Map? convInfor, StringeeClient client)

Creates a conversation from native convInfor.

Properties

createdAt → int?

Creation time in milliseconds since Unix epoch.

no setter

creator → String?

User ID of the conversation creator.

no setter

customData → String?

Application-specific conversation data.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

Server-assigned conversation ID.

no setter

isGroup → bool?

Whether this is a group conversation.

no setter

lastMsg → StringeeMessage?

Most recent message summary.

no setter

name → String?

Conversation display name.

no setter

oaId → String?

Official Account ID associated with this conversation.

no setter

participants → List<StringeeUser>?

Current conversation participants.

no setter

pinnedMsgId → String?

ID of the pinned message, if any.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

text → Map?

Raw content of the last-message summary.

no setter

totalUnread → int?

Number of unread messages for the current user.

no setter

updatedAt → int?

Last update time in milliseconds since Unix epoch.

no setter

Methods

addParticipants(List<StringeeUser> participants) → Future<Map>

Adds participants to this conversation.

beginTyping() → Future<Map>

Sends a begin-typing state for this conversation.

delete() → Future<Map>

Deletes this conversation.

deleteMessages(List<String> msgIds) → Future<Map>

Deletes messages by msgIds.

endChat() → Future<Map>

Ends this live chat conversation.

endTyping() → Future<Map>

Sends an end-typing state for this conversation.

getLastMessages(int count) → Future<Map>

Gets the latest count messages in this conversation from the server.

getLocalMessages(int count) → Future<Map>

Gets count locally cached messages in this conversation.

getMessages(List<String> msgIds) → Future<Map>

Gets messages in this conversation by msgIds.

getMessagesAfter(int count, int sequence) → Future<Map>

Gets count messages after sequence in this conversation.

getMessagesBefore(int count, int sequence) → Future<Map>

Gets count messages before sequence in this conversation.

markAsRead() → Future<Map>

Marks this conversation as read.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeParticipants(List<StringeeUser> participants) → Future<Map>

Removes participants from this conversation.

revokeMessages(List<String> msgIds, bool isDeleted) → Future<Map>

Revokes messages by msgIds, optionally marking them as deleted.

sendChatTranscript(String email, String domain) → Future<Map>

Sends this live chat transcript to email for domain.

sendMessage(StringeeMessage message) → Future<Map>

Sends a message to this conversation.

setRole(String userId, UserRole role) → Future<Map>

Changes userId's role in this conversation.

toString() → String

A string representation of this object.

override

updateConversation(String name) → Future<Map>

Updates this conversation name.

Operators

operator ==(Object other) → bool

The equality operator.

inherited