menu

$ChatClient class

$ChatClient class

Constructors

$ChatClient.new($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({required String token, ChatClearHistoryApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>>: Clear the chat history.
clearHistoryRaw({required String token, ChatClearHistoryApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
deleteMessageRaw({required String token, required int messageId, ChatDeleteMessageApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
deleteReminderRaw({required String token, required int messageId, ChatDeleteReminderApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<ChatDeleteReminderResponseApplicationJson, void>: Delete a chat reminder.
getMessageContext({required String token, required int messageId, int? limit, ChatGetMessageContextApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<ChatGetMessageContextResponseApplicationJson, ChatChatGetMessageContextHeaders>>: Get the context of a message.
getMessageContextRaw({required String token, required int messageId, int? limit, ChatGetMessageContextApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
getObjectsSharedInRoomOverviewRaw({required String token, int? limit, ChatGetObjectsSharedInRoomOverviewApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<ChatGetObjectsSharedInRoomOverviewResponseApplicationJson, void>: Get objects that are shared in the room overview.
getObjectsSharedInRoomRaw({required String objectType, required String token, int? lastKnownMessageId, int? limit, ChatGetObjectsSharedInRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<ChatGetObjectsSharedInRoomResponseApplicationJson, ChatChatGetObjectsSharedInRoomHeaders>: Get objects that are shared in the room.
getReminder({required String token, required int messageId, ChatGetReminderApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<ChatGetReminderResponseApplicationJson, void>>: Get the reminder for a chat message.
getReminderRaw({required String token, required int messageId, ChatGetReminderApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
markUnreadRaw({required String token, ChatMarkUnreadApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
mentionsRaw({required String search, required String token, int? limit, ChatMentionsIncludeStatus? includeStatus, ChatMentionsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
receiveMessagesRaw({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}) → DynamiteRawResponse<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.
sendMessageRaw({required String message, required String token, String? actorDisplayName, String? referenceId, int? replyTo, ChatSendMessageSilent? silent, ChatSendMessageApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<ChatSendMessageResponseApplicationJson, ChatChatSendMessageHeaders>: Sends a new chat message to the given room.
setReadMarker({required int lastReadMessage, required String token, ChatSetReadMarkerApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<ChatSetReadMarkerResponseApplicationJson, ChatChatSetReadMarkerHeaders>>: Set the read marker to a specific message.
setReadMarkerRaw({required int lastReadMessage, required String token, ChatSetReadMarkerApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
setReminderRaw({required int timestamp, required String token, required int messageId, ChatSetReminderApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<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.
shareObjectToChatRaw({required String objectType, required String objectId, required String token, String? metaData, String? actorDisplayName, String? referenceId, ChatShareObjectToChatApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders>: Sends a rich-object to the given room.
toString() → String: A string representation of this object.
inherited

Operators

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