$ChatClient class
Constructors
-
$ChatClient($Client _rootClient)
-
Creates a new
DynamiteClient for chat requests.
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$clearHistory_Request({required String token, ChatClearHistoryApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Clear the chat history.
-
$clearHistory_Serializer()
→ DynamiteSerializer<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>
-
Builds a serializer to parse the response of $clearHistory_Request.
-
$deleteMessage_Request({required String token, required int messageId, ChatDeleteMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Delete a chat message.
-
$deleteMessage_Serializer()
→ DynamiteSerializer<ChatDeleteMessageResponseApplicationJson, ChatChatDeleteMessageHeaders>
-
Builds a serializer to parse the response of $deleteMessage_Request.
-
$deleteReminder_Request({required String token, required int messageId, ChatDeleteReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Delete a chat reminder.
-
$deleteReminder_Serializer()
→ DynamiteSerializer<ChatDeleteReminderResponseApplicationJson, void>
-
Builds a serializer to parse the response of $deleteReminder_Request.
-
$editMessage_Request({required String message, required String token, required int messageId, ChatEditMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Edit a chat message.
-
$editMessage_Serializer()
→ DynamiteSerializer<ChatEditMessageResponseApplicationJson, ChatChatEditMessageHeaders>
-
Builds a serializer to parse the response of $editMessage_Request.
-
$getMessageContext_Request({required String token, required int messageId, int? limit, ChatGetMessageContextApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Get the context of a message.
-
$getMessageContext_Serializer()
→ DynamiteSerializer<ChatGetMessageContextResponseApplicationJson, ChatChatGetMessageContextHeaders>
-
Builds a serializer to parse the response of $getMessageContext_Request.
-
$getObjectsSharedInRoom_Request({required String objectType, required String token, int? lastKnownMessageId, int? limit, ChatGetObjectsSharedInRoomApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Get objects that are shared in the room.
-
$getObjectsSharedInRoom_Serializer()
→ DynamiteSerializer<ChatGetObjectsSharedInRoomResponseApplicationJson, ChatChatGetObjectsSharedInRoomHeaders>
-
Builds a serializer to parse the response of $getObjectsSharedInRoom_Request.
-
$getObjectsSharedInRoomOverview_Request({required String token, int? limit, ChatGetObjectsSharedInRoomOverviewApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Get objects that are shared in the room overview.
-
$getObjectsSharedInRoomOverview_Serializer()
→ DynamiteSerializer<ChatGetObjectsSharedInRoomOverviewResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getObjectsSharedInRoomOverview_Request.
-
$getReminder_Request({required String token, required int messageId, ChatGetReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Get the reminder for a chat message.
-
$getReminder_Serializer()
→ DynamiteSerializer<ChatGetReminderResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getReminder_Request.
-
$markUnread_Request({required String token, ChatMarkUnreadApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Mark a chat as unread.
-
$markUnread_Serializer()
→ DynamiteSerializer<ChatMarkUnreadResponseApplicationJson, ChatChatMarkUnreadHeaders>
-
Builds a serializer to parse the response of $markUnread_Request.
-
$mentions_Request({required String search, required String token, int? limit, ChatMentionsIncludeStatus? includeStatus, ChatMentionsApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Search for mentions.
-
$mentions_Serializer()
→ DynamiteSerializer<ChatMentionsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $mentions_Request.
-
$receiveMessages_Request({required ChatReceiveMessagesLookIntoFuture lookIntoFuture, required String token, int? limit, int? lastKnownMessageId, int? lastCommonReadId, int? timeout, ChatReceiveMessagesSetReadMarker? setReadMarker, ChatReceiveMessagesIncludeLastKnown? includeLastKnown, ChatReceiveMessagesNoStatusUpdate? noStatusUpdate, ChatReceiveMessagesMarkNotificationsAsRead? markNotificationsAsRead, ChatReceiveMessagesApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Receives chat messages from the given room.
-
$receiveMessages_Serializer()
→ DynamiteSerializer<ChatReceiveMessagesResponseApplicationJson, ChatChatReceiveMessagesHeaders>
-
Builds a serializer to parse the response of $receiveMessages_Request.
-
$sendMessage_Request({required String message, required String token, String? actorDisplayName, String? referenceId, int? replyTo, ChatSendMessageSilent? silent, ChatSendMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Sends a new chat message to the given room.
-
$sendMessage_Serializer()
→ DynamiteSerializer<ChatSendMessageResponseApplicationJson, ChatChatSendMessageHeaders>
-
Builds a serializer to parse the response of $sendMessage_Request.
-
$setReadMarker_Request({required String token, int? lastReadMessage, ChatSetReadMarkerApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Set the read marker to a specific message.
-
$setReadMarker_Serializer()
→ DynamiteSerializer<ChatSetReadMarkerResponseApplicationJson, ChatChatSetReadMarkerHeaders>
-
Builds a serializer to parse the response of $setReadMarker_Request.
-
$setReminder_Request({required int timestamp, required String token, required int messageId, ChatSetReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Set a reminder for a chat message.
-
$setReminder_Serializer()
→ DynamiteSerializer<ChatSetReminderResponseApplicationJson, void>
-
Builds a serializer to parse the response of $setReminder_Request.
-
$shareObjectToChat_Request({required String objectType, required String objectId, required String token, String? metaData, String? actorDisplayName, String? referenceId, ChatShareObjectToChatApiVersion? apiVersion, bool? oCSAPIRequest})
→ Request
-
Sends a rich-object to the given room.
-
$shareObjectToChat_Serializer()
→ DynamiteSerializer<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders>
-
Builds a serializer to parse the response of $shareObjectToChat_Request.
-
clearHistory({required String token, ChatClearHistoryApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>>
-
Clear the chat history.
-
deleteMessage({required String token, required int messageId, ChatDeleteMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatDeleteMessageResponseApplicationJson, ChatChatDeleteMessageHeaders>>
-
Delete a chat message.
-
deleteReminder({required String token, required int messageId, ChatDeleteReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatDeleteReminderResponseApplicationJson, void>>
-
Delete a chat reminder.
-
editMessage({required String message, required String token, required int messageId, ChatEditMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatEditMessageResponseApplicationJson, ChatChatEditMessageHeaders>>
-
Edit a chat message.
-
getMessageContext({required String token, required int messageId, int? limit, ChatGetMessageContextApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatGetMessageContextResponseApplicationJson, ChatChatGetMessageContextHeaders>>
-
Get the context of a message.
-
getObjectsSharedInRoom({required String objectType, required String token, int? lastKnownMessageId, int? limit, ChatGetObjectsSharedInRoomApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatGetObjectsSharedInRoomResponseApplicationJson, ChatChatGetObjectsSharedInRoomHeaders>>
-
Get objects that are shared in the room.
-
getObjectsSharedInRoomOverview({required String token, int? limit, ChatGetObjectsSharedInRoomOverviewApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatGetObjectsSharedInRoomOverviewResponseApplicationJson, void>>
-
Get objects that are shared in the room overview.
-
getReminder({required String token, required int messageId, ChatGetReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatGetReminderResponseApplicationJson, void>>
-
Get the reminder for a chat message.
-
markUnread({required String token, ChatMarkUnreadApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatMarkUnreadResponseApplicationJson, ChatChatMarkUnreadHeaders>>
-
Mark a chat as unread.
-
mentions({required String search, required String token, int? limit, ChatMentionsIncludeStatus? includeStatus, ChatMentionsApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatMentionsResponseApplicationJson, void>>
-
Search for mentions.
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
receiveMessages({required ChatReceiveMessagesLookIntoFuture lookIntoFuture, required String token, int? limit, int? lastKnownMessageId, int? lastCommonReadId, int? timeout, ChatReceiveMessagesSetReadMarker? setReadMarker, ChatReceiveMessagesIncludeLastKnown? includeLastKnown, ChatReceiveMessagesNoStatusUpdate? noStatusUpdate, ChatReceiveMessagesMarkNotificationsAsRead? markNotificationsAsRead, ChatReceiveMessagesApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatReceiveMessagesResponseApplicationJson, ChatChatReceiveMessagesHeaders>>
-
Receives chat messages from the given room.
-
sendMessage({required String message, required String token, String? actorDisplayName, String? referenceId, int? replyTo, ChatSendMessageSilent? silent, ChatSendMessageApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatSendMessageResponseApplicationJson, ChatChatSendMessageHeaders>>
-
Sends a new chat message to the given room.
-
setReadMarker({required String token, int? lastReadMessage, ChatSetReadMarkerApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatSetReadMarkerResponseApplicationJson, ChatChatSetReadMarkerHeaders>>
-
Set the read marker to a specific message.
-
setReminder({required int timestamp, required String token, required int messageId, ChatSetReminderApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatSetReminderResponseApplicationJson, void>>
-
Set a reminder for a chat message.
-
shareObjectToChat({required String objectType, required String objectId, required String token, String? metaData, String? actorDisplayName, String? referenceId, ChatShareObjectToChatApiVersion? apiVersion, bool? oCSAPIRequest})
→ Future<DynamiteResponse<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders>>
-
Sends a rich-object to the given room.
-
toString()
→ String
-
A string representation of this object.
inherited
