Class DefaultDirectChatsModule

Direct Chat management for the Secure Communications Service.

Implements

DirectChatsModule

Index

Constructors

Methods

acceptInvitation blockHandle createChat declineInvitation listBlockedHandles listInvitations listJoined unblockHandle

Constructors

constructor

new DefaultDirectChatsModule(
sessionManager: SessionManager,
): DefaultDirectChatsModule
Parameters
- sessionManager: SessionManager
Returns DefaultDirectChatsModule
- Defined in src/public/modules/directChatsModule.ts:154

Methods

acceptInvitation

acceptInvitation(input: AcceptInvitationInput): Promise<void>
Accept an invitation to join a direct chat.
Parameters
- input: AcceptInvitationInput
  Parameters used to accept an invitation to join a direct chat.
Returns Promise<void>
Implementation of DirectChatsModule.acceptInvitation
- Defined in src/public/modules/directChatsModule.ts:169

blockHandle

blockHandle(input: BlockHandleInput): Promise<void>
Blocks a handle.
Parameters
- input: BlockHandleInput
  Parameters used to block a handle.
Returns Promise<void>
Implementation of DirectChatsModule.blockHandle
- Defined in src/public/modules/directChatsModule.ts:211

createChat

createChat(input: CreateChatInput): Promise<ChatId>
Creates a direct chat with another handle.
Parameters
- input: CreateChatInput
  Parameters used to create a new direct chat.
Returns Promise<ChatId>
The identifier of the direct chat.
Implementation of DirectChatsModule.createChat
- Defined in src/public/modules/directChatsModule.ts:158

declineInvitation

declineInvitation(input: DeclineInvitationInput): Promise<void>
Decline an invitation to join a direct chat.
Parameters
- input: DeclineInvitationInput
  Parameters used to decline an invitation to join a direct chat.
Returns Promise<void>
Implementation of DirectChatsModule.declineInvitation
- Defined in src/public/modules/directChatsModule.ts:180

listBlockedHandles

listBlockedHandles(handleId: HandleId): Promise<HandleId[]>
Retrieves a list of all known blocked handles for this handle.
Parameters
- handleId: HandleId
  Identifier of the handle owned by this client.
Returns Promise<HandleId[]>
A list of the handle identifiers of the handles that are blocked.
Implementation of DirectChatsModule.listBlockedHandles
- Defined in src/public/modules/directChatsModule.ts:233

listInvitations

listInvitations(handleId: HandleId): Promise<DirectChatInvitation[]>
Retrieves a list of all direct chats that this handle has an invitation for.
Parameters
- handleId: HandleId
  Identifier of the handle owned by this client.
Returns Promise<DirectChatInvitation[]>
A list of direct chat invitations for this handle.
Implementation of DirectChatsModule.listInvitations
- Defined in src/public/modules/directChatsModule.ts:191

listJoined

listJoined(handleId: HandleId): Promise<DirectChat[]>
Retrieves a list of all direct chats that this handle has joined.
Parameters
- handleId: HandleId
  Identifier of the handle owned by this client.
Returns Promise<DirectChat[]>
A list of direct chats that this handle has joined.
Implementation of DirectChatsModule.listJoined
- Defined in src/public/modules/directChatsModule.ts:201

unblockHandle

unblockHandle(input: UnblockHandleInput): Promise<void>
Unblocks a handle.
Parameters
- input: UnblockHandleInput
  Parameters used to unblock a handle
Returns Promise<void>
Implementation of DirectChatsModule.unblockHandle
- Defined in src/public/modules/directChatsModule.ts:222