ChatClient | @azure/communication-chat

The client to do chat operations

Hierarchy

ChatClient

Index

Constructors

constructor

Methods

Constructors

constructor

new ChatClient(url: string, credential: CommunicationTokenCredential, options?: ChatClientOptions): ChatClient

- Defined in chatClient.ts:67
Creates an instance of the ChatClient for a given resource and user.

Parameters
- url: string
  
  The url of the Communication Services resouce.
- credential: CommunicationTokenCredential
  
  The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential.
- Default value options: ChatClientOptions = {}
  
  Additional client options.
Returns ChatClient

Methods

createChatThread

createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

- Defined in chatClient.ts:128
Creates a chat thread. Returns thread client with the id of the created thread.

Parameters
- request: CreateChatThreadRequest
  
  Request for creating a chat thread.
- Default value options: CreateChatThreadOptions = {}
  
  Operation options.
Returns Promise<CreateChatThreadResult>

deleteChatThread

deleteChatThread(threadId: string, options?: DeleteChatThreadOptions): Promise<void>

- Defined in chatClient.ts:260
Deletes a chat thread.

Parameters
- threadId: string
  
  The ID of the thread to delete.
- Default value options: DeleteChatThreadOptions = {}
  
  Operation options.
Returns Promise<void>

getChatThread

getChatThread(threadId: string, options?: GetChatThreadOptions): Promise<ChatThread>

- Defined in chatClient.ts:165
Gets a chat thread. Returns the chat thread.

Parameters
- threadId: string
  
  The ID of the thread to get.
- Default value options: GetChatThreadOptions = {}
  
  Operation options.
Returns Promise<ChatThread>

getChatThreadClient

getChatThreadClient(threadId: string): ChatThreadClient

- Defined in chatClient.ts:118
Returns ChatThreadClient with the specific thread id.

Parameters
- threadId: string
  
  Thread ID for the ChatThreadClient
Returns ChatThreadClient

listChatThreads

listChatThreads(options?: ListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadInfo>

- Defined in chatClient.ts:227
Gets the list of chat threads of a user.

Parameters
- Default value options: ListChatThreadsOptions = {}
  
  List chat threads options.
Returns PagedAsyncIterableIterator<ChatThreadInfo>

off

off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void
off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void
off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void
off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void
off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void
off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void
off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void
off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void
off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void
off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void

- Defined in chatClient.ts:414
Unsubscribe from chatMessageReceived.

Parameters
- event: "chatMessageReceived"
  
  The ChatMessageReceivedEvent.
- listener: (e: ChatMessageReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageReceivedEvent): void
    - Parameters
      - e: ChatMessageReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:421
Unsubscribe from chatMessageEdited.

Parameters
- event: "chatMessageEdited"
  
  The ChatMessageEditedEvent.
- listener: (e: ChatMessageEditedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageEditedEvent): void
    - Parameters
      - e: ChatMessageEditedEvent
      Returns void
Returns void
- Defined in chatClient.ts:428
Unsubscribe from chatMessageDeleted.

Parameters
- event: "chatMessageDeleted"
  
  The ChatMessageDeletedEvent.
- listener: (e: ChatMessageDeletedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageDeletedEvent): void
    - Parameters
      - e: ChatMessageDeletedEvent
      Returns void
Returns void
- Defined in chatClient.ts:435
Unsubscribe from typingIndicatorReceived.

Parameters
- event: "typingIndicatorReceived"
  
  The TypingIndicatorReceivedEvent.
- listener: (e: TypingIndicatorReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: TypingIndicatorReceivedEvent): void
    - Parameters
      - e: TypingIndicatorReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:445
Unsubscribe from readReceiptReceived.

Parameters
- event: "readReceiptReceived"
  
  The ReadReceiptReceivedEvent.
- listener: (e: ReadReceiptReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: ReadReceiptReceivedEvent): void
    - Parameters
      - e: ReadReceiptReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:452
Unsubscribe from chatThreadCreated.

Parameters
- event: "chatThreadCreated"
  
  The ChatThreadCreatedEvent.
- listener: (e: ChatThreadCreatedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadCreatedEvent): void
    - Parameters
      - e: ChatThreadCreatedEvent
      Returns void
Returns void
- Defined in chatClient.ts:459
Unsubscribe from chatThreadDeleted.

Parameters
- event: "chatThreadDeleted"
  
  The ChatThreadDeletedEvent.
- listener: (e: ChatThreadDeletedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadDeletedEvent): void
    - Parameters
      - e: ChatThreadDeletedEvent
      Returns void
Returns void
- Defined in chatClient.ts:466
Unsubscribe from chatThreadPropertiesUpdated.

Parameters
- event: "chatThreadPropertiesUpdated"
  
  The ChatThreadPropertiesUpdatedEvent.
- listener: (e: ChatThreadPropertiesUpdatedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadPropertiesUpdatedEvent): void
    - Parameters
      - e: ChatThreadPropertiesUpdatedEvent
      Returns void
Returns void
- Defined in chatClient.ts:476
Unsubscribe from participantsAdded.

Parameters
- event: "participantsAdded"
  
  The ParticipantsAddedEvent.
- listener: (e: ParticipantsAddedEvent) => void
  
  The listener to handle the event.
  - - (e: ParticipantsAddedEvent): void
    - Parameters
      - e: ParticipantsAddedEvent
      Returns void
Returns void
- Defined in chatClient.ts:483
Unsubscribe from participantsRemoved.

Parameters
- event: "participantsRemoved"
  
  The ParticipantsRemovedEvent.
- listener: (e: ParticipantsRemovedEvent) => void
  
  The listener to handle the event.
  - - (e: ParticipantsRemovedEvent): void
    - Parameters
      - e: ParticipantsRemovedEvent
      Returns void
Returns void

on

on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void
on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void
on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void
on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void
on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void
on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void
on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void
on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void
on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void
on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void

- Defined in chatClient.ts:321
Subscribe function for chatMessageReceived. The initial sender will also receive this event. You need to call startRealtimeNotifications before subscribing to any event.

Parameters
- event: "chatMessageReceived"
  
  The ChatMessageReceivedEvent.
- listener: (e: ChatMessageReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageReceivedEvent): void
    - Parameters
      - e: ChatMessageReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:329
Subscribe function for chatMessageEdited. The initial sender will also receive this event.

Parameters
- event: "chatMessageEdited"
  
  The ChatMessageEditedEvent.
- listener: (e: ChatMessageEditedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageEditedEvent): void
    - Parameters
      - e: ChatMessageEditedEvent
      Returns void
Returns void
- Defined in chatClient.ts:337
Subscribe function for chatMessageDeleted. The initial sender will also receive this event.

Parameters
- event: "chatMessageDeleted"
  
  The ChatMessageDeletedEvent.
- listener: (e: ChatMessageDeletedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatMessageDeletedEvent): void
    - Parameters
      - e: ChatMessageDeletedEvent
      Returns void
Returns void
- Defined in chatClient.ts:345
Subscribe function for typingIndicatorReceived. The initial sender will also receive this event.

Parameters
- event: "typingIndicatorReceived"
  
  The TypingIndicatorReceivedEvent.
- listener: (e: TypingIndicatorReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: TypingIndicatorReceivedEvent): void
    - Parameters
      - e: TypingIndicatorReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:355
Subscribe function for readReceiptReceived.

Parameters
- event: "readReceiptReceived"
  
  The ReadReceiptReceivedEvent.
- listener: (e: ReadReceiptReceivedEvent) => void
  
  The listener to handle the event.
  - - (e: ReadReceiptReceivedEvent): void
    - Parameters
      - e: ReadReceiptReceivedEvent
      Returns void
Returns void
- Defined in chatClient.ts:362
Subscribe function for chatThreadCreated.

Parameters
- event: "chatThreadCreated"
  
  The ChatThreadCreatedEvent.
- listener: (e: ChatThreadCreatedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadCreatedEvent): void
    - Parameters
      - e: ChatThreadCreatedEvent
      Returns void
Returns void
- Defined in chatClient.ts:369
Subscribe function for chatThreadDeleted.

Parameters
- event: "chatThreadDeleted"
  
  The ChatThreadDeletedEvent.
- listener: (e: ChatThreadDeletedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadDeletedEvent): void
    - Parameters
      - e: ChatThreadDeletedEvent
      Returns void
Returns void
- Defined in chatClient.ts:376
Subscribe function for chatThreadPropertiesUpdated.

Parameters
- event: "chatThreadPropertiesUpdated"
  
  The ChatThreadPropertiesUpdatedEvent.
- listener: (e: ChatThreadPropertiesUpdatedEvent) => void
  
  The listener to handle the event.
  - - (e: ChatThreadPropertiesUpdatedEvent): void
    - Parameters
      - e: ChatThreadPropertiesUpdatedEvent
      Returns void
Returns void
- Defined in chatClient.ts:386
Subscribe function for participantsAdded.

Parameters
- event: "participantsAdded"
  
  The ParticipantsAddedEvent.
- listener: (e: ParticipantsAddedEvent) => void
  
  The listener to handle the event.
  - - (e: ParticipantsAddedEvent): void
    - Parameters
      - e: ParticipantsAddedEvent
      Returns void
Returns void
- Defined in chatClient.ts:393
Subscribe function for participantsRemoved.

Parameters
- event: "participantsRemoved"
  
  The ParticipantsRemovedEvent.
- listener: (e: ParticipantsRemovedEvent) => void
  
  The listener to handle the event.
  - - (e: ParticipantsRemovedEvent): void
    - Parameters
      - e: ParticipantsRemovedEvent
      Returns void
Returns void

startRealtimeNotifications

startRealtimeNotifications(): Promise<void>

- Defined in chatClient.ts:286
Start receiving realtime notifications. Call this function before subscribing to any event.

Returns Promise<void>

stopRealtimeNotifications

stopRealtimeNotifications(): Promise<void>

- Defined in chatClient.ts:304
Stop receiving realtime notifications. This function would unsubscribe to all events.

Returns Promise<void>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

url: string

credential: CommunicationTokenCredential

Default value options: ChatClientOptions = {}

Returns ChatClient

Methods

createChatThread

Parameters

request: CreateChatThreadRequest

Default value options: CreateChatThreadOptions = {}

Returns Promise<CreateChatThreadResult>

deleteChatThread

Parameters

threadId: string

Default value options: DeleteChatThreadOptions = {}

Returns Promise<void>

getChatThread

Parameters

threadId: string

Default value options: GetChatThreadOptions = {}

Returns Promise<ChatThread>

getChatThreadClient

Parameters

threadId: string

Returns ChatThreadClient

listChatThreads

Parameters

Default value options: ListChatThreadsOptions = {}

Returns PagedAsyncIterableIterator<ChatThreadInfo>

off

Parameters

event: "chatMessageReceived"

listener: (e: ChatMessageReceivedEvent) => void

Parameters

e: ChatMessageReceivedEvent

Returns void

Returns void

Parameters

event: "chatMessageEdited"

listener: (e: ChatMessageEditedEvent) => void

Parameters

e: ChatMessageEditedEvent

Returns void

Returns void

Parameters

event: "chatMessageDeleted"

listener: (e: ChatMessageDeletedEvent) => void

Parameters

e: ChatMessageDeletedEvent

Returns void

Returns void

Parameters

event: "typingIndicatorReceived"

listener: (e: TypingIndicatorReceivedEvent) => void

Parameters

e: TypingIndicatorReceivedEvent

Returns void

Returns void

Parameters

event: "readReceiptReceived"

listener: (e: ReadReceiptReceivedEvent) => void

Parameters

e: ReadReceiptReceivedEvent

Returns void

Returns void

Parameters

event: "chatThreadCreated"

listener: (e: ChatThreadCreatedEvent) => void

Parameters

e: ChatThreadCreatedEvent

Returns void

Returns void

Parameters

event: "chatThreadDeleted"