Class DefaultMessagingModule

Messaging management for the Secure Communications Service.

Each method on this interface takes an input which includes a Recipient parameter representing a "Chat" with either a Direct Chat, Channel or Group.

Implements

MessagingModule

Constructors

constructor

new DefaultMessagingModule(
    sessionManager: SessionManager,
    mediaCredentialManager: MediaCredentialManager,
    secureCommsServiceConfig: {
        advancedSearchEnabled: boolean;
        homeServer: string;
        publicMediaBucket: string;
        region: string;
        roomMediaBucket: string;
        serviceEndpointUrl: string;
    },
): DefaultMessagingModule
Parameters
- sessionManager: SessionManager
- mediaCredentialManager: MediaCredentialManager
- secureCommsServiceConfig: {
      advancedSearchEnabled: boolean;
      homeServer: string;
      publicMediaBucket: string;
      region: string;
      roomMediaBucket: string;
      serviceEndpointUrl: string;
  }
Returns DefaultMessagingModule
- Defined in src/public/modules/messagingModule.ts:661

Methods

createPoll

createPoll(input: CreatePollInput): Promise<void>
Creates a poll.
Parameters
- input: CreatePollInput
  Parameters used to create a poll.
Returns Promise<void>
Implementation of MessagingModule.createPoll
- Defined in src/public/modules/messagingModule.ts:889

deleteMessage

deleteMessage(input: DeleteMessageInput): Promise<void>
Deletes an existing message that has been sent to a recipient. The original message is removed for all members of the chat.
Parameters
- input: DeleteMessageInput
  Parameters used to delete a message.
Returns Promise<void>
Implementation of MessagingModule.deleteMessage
- Defined in src/public/modules/messagingModule.ts:802

editMediaCaption

editMediaCaption(input: EditMediaCaptionInput): Promise<void>
Edits the caption for an existing media attachment that has been sent to a recipient. The original message is replaced by the edited message for all members of the chat.
Parameters
- input: EditMediaCaptionInput
  Parameters used to edit a caption for a media attachment.
Returns Promise<void>
Implementation of MessagingModule.editMediaCaption
- Defined in src/public/modules/messagingModule.ts:826

editMessage

editMessage(input: EditMessageInput): Promise<void>
Edits an existing message that has been sent to a recipient. The original message is replaced by the edited message for all members of the chat.
Parameters
- input: EditMessageInput
  Parameters used to edit a message.
Returns Promise<void>
Implementation of MessagingModule.editMessage
- Defined in src/public/modules/messagingModule.ts:789

editPoll

editPoll(input: EditPollInput): Promise<void>
Edits an existing poll.
Parameters
- input: EditPollInput
  Parameters used to edit a poll.
Returns Promise<void>
Implementation of MessagingModule.editPoll
- Defined in src/public/modules/messagingModule.ts:913

endPoll

endPoll(input: EndPollInput): Promise<void>
Ends a poll.
Parameters
- input: EndPollInput
  Parameters used to end a poll.
Returns Promise<void>
Implementation of MessagingModule.endPoll
- Defined in src/public/modules/messagingModule.ts:930

getChatSummaries

getChatSummaries(input: GetChatSummariesInput): Promise<ChatSummary[]>
Retrieves a chat summary for the supplied set of recipients.
Parameters
- input: GetChatSummariesInput
  Parameters used to retrieve chat summaries.
Returns Promise<ChatSummary[]>
A list of chat summary items containing the latest message (if available) for each supplied recipient.
Implementation of MessagingModule.getChatSummaries
- Defined in src/public/modules/messagingModule.ts:721

getMessage

getMessage(input: GetMessageInput): Promise<Message | undefined>
Retrieve an individual message for a given recipient by the message's identifier.
Parameters
- input: GetMessageInput
  Parameters used to retrieve a message.
Returns Promise<Message | undefined>
The message matching the input identifier, or undefined if not found.
Implementation of MessagingModule.getMessage
- Defined in src/public/modules/messagingModule.ts:687

getMessages

getMessages(input: GetMessagesInput): Promise<ListOutput<Message>>
Retrieve a list of messages for a given recipient, ordered from newest message to oldest.
Parameters
- input: GetMessagesInput
  Parameters used to retrieve a list of messages.
Returns Promise<ListOutput<Message>>
A list of message items and a next token to support pagination.
Implementation of MessagingModule.getMessages
- Defined in src/public/modules/messagingModule.ts:669

getPinnedMessages

getPinnedMessages(input: GetPinnedMessagesInput): Promise<Message[]>
Retrieve a list of pinned messages for a given recipient, ordered from newest message to oldest.
Parameters
- input: GetPinnedMessagesInput
  Parameters used to retrieve a list of pinned messages.
Returns Promise<Message[]>
A list of pinned message items.
Implementation of MessagingModule.getPinnedMessages
- Defined in src/public/modules/messagingModule.ts:874

getPollResponses

getPollResponses(input: GetPollResponsesInput): Promise<PollResponses>
Tallies the responses for a given poll.
Parameters
- input: GetPollResponsesInput
  Parameters used to tally the responses for a given poll.
Returns Promise<PollResponses>
The tallied responses for the poll.
Implementation of MessagingModule.getPollResponses
- Defined in src/public/modules/messagingModule.ts:938

markAsRead

markAsRead(input: MarkAsReadInput): Promise<void>
Marks the chat with a recipient as read.
Parameters
- input: MarkAsReadInput
  Parameters used to mark messages as read.
Returns Promise<void>
Implementation of MessagingModule.markAsRead
- Defined in src/public/modules/messagingModule.ts:734

pinMessage

pinMessage(input: PinMessageInput): Promise<void>
Pins an existing message for a given recipient.
Parameters
- input: PinMessageInput
  Parameters used to pin an existing message.
Returns Promise<void>
Implementation of MessagingModule.pinMessage
- Defined in src/public/modules/messagingModule.ts:850

registerMessageListener

registerMessageListener(input: RegisterMessageListenerInput): Promise<void>
Registers a message listener.
Parameters
- input: RegisterMessageListenerInput
  Parameters used to register a message listener.
Returns Promise<void>
Implementation of MessagingModule.registerMessageListener
- Defined in src/public/modules/messagingModule.ts:948

searchMessages

searchMessages(
input: SearchMessagesInput,
): Promise<ListOutput<SearchMessagesItem>>
Retrieves a list of messages from all unencrypted channels/groups matching search keywords.
Parameters
- input: SearchMessagesInput
  Parameters used to search for messages.
Returns Promise<ListOutput<SearchMessagesItem>>
The search results representing a list of message items and a next token to support pagination.
Implementation of MessagingModule.searchMessages
- Defined in src/public/modules/messagingModule.ts:701

sendMedia

sendMedia(input: SendMediaInput): Promise<void>
Uploads and sends a media message to a recipient. Supported media types are images, videos, audio, and files.
Parameters
- input: SendMediaInput
  Parameters used to send a media message.
Returns Promise<void>
Implementation of MessagingModule.sendMedia
- Defined in src/public/modules/messagingModule.ts:815

sendMessage

sendMessage(input: SendMessageInput): Promise<void>
Sends a message to a recipient.
Parameters
- input: SendMessageInput
  Parameters used to send a message including any other associated metadata.
Returns Promise<void>
Implementation of MessagingModule.sendMessage
- Defined in src/public/modules/messagingModule.ts:759

sendPollResponse

sendPollResponse(input: SendPollResponseInput): Promise<void>
Sends a response to a poll.
Parameters
- input: SendPollResponseInput
  Parameters used to send a response to a poll.
Returns Promise<void>
Implementation of MessagingModule.sendPollResponse
- Defined in src/public/modules/messagingModule.ts:905

sendTypingNotification

sendTypingNotification(input: SendTypingNotificationInput): Promise<void>
Sends a typing notification for this handle.
Parameters
- input: SendTypingNotificationInput
  Parameters used to send a typing notification.
Returns Promise<void>
Implementation of MessagingModule.sendTypingNotification
- Defined in src/public/modules/messagingModule.ts:745

toggleReaction

toggleReaction(input: ToggleReactionInput): Promise<void>
Toggles a reaction for an existing message. All members of the chat will have visibility of the reaction.
Parameters
- input: ToggleReactionInput
  Parameters used to toggle a reaction.
Returns Promise<void>
Implementation of MessagingModule.toggleReaction
- Defined in src/public/modules/messagingModule.ts:837

unpinMessage

unpinMessage(input: UnpinMessageInput): Promise<void>
Unpins an existing message for a given recipient.
Parameters
- input: UnpinMessageInput
  Parameters used to unpin an existing message.
Returns Promise<void>
Implementation of MessagingModule.unpinMessage
- Defined in src/public/modules/messagingModule.ts:862

unregisterMessageListener

unregisterMessageListener(input: UnregisterMessageListenerInput): Promise<void>
Unregisters a message listener.
Parameters
- input: UnregisterMessageListenerInput
  Parameters used to unregister a message listener.
Returns Promise<void>
Implementation of MessagingModule.unregisterMessageListener
- Defined in src/public/modules/messagingModule.ts:970

Class DefaultMessagingModule

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefaultMessagingModule

Methods

createPoll

Parameters

Returns Promise<void>

deleteMessage

Parameters

Returns Promise<void>

editMediaCaption

Parameters

Returns Promise<void>

editMessage

Parameters

Returns Promise<void>

editPoll

Parameters

Returns Promise<void>

endPoll

Parameters

Returns Promise<void>

getChatSummaries

Parameters

Returns Promise<ChatSummary[]>

getMessage

Parameters

Returns Promise<Message | undefined>

getMessages

Parameters

Returns Promise<ListOutput<Message>>

getPinnedMessages

Parameters

Returns Promise<Message[]>

getPollResponses

Parameters

Returns Promise<PollResponses>

markAsRead

Parameters

Returns Promise<void>

pinMessage

Parameters

Returns Promise<void>

registerMessageListener

Parameters

Returns Promise<void>

searchMessages

Parameters

Returns Promise<ListOutput<SearchMessagesItem>>

sendMedia

Parameters

Returns Promise<void>

sendMessage

Parameters

Returns Promise<void>

sendPollResponse

Parameters

Returns Promise<void>

sendTypingNotification

Parameters

Returns Promise<void>

toggleReaction

Parameters

Returns Promise<void>

unpinMessage

Parameters

Returns Promise<void>

unregisterMessageListener

Parameters

Returns Promise<void>

Settings

On This Page