Package version:

Class ChatClient

The client to do chat operations

Hierarchy

ChatClient

Index

Constructors

Methods

createChatThread deleteChatThread getChatThreadClient listChatThreads off on startRealtimeNotifications stopRealtimeNotifications

Constructors

constructor

new ChatClient(endpoint: string, credential: CommunicationTokenCredential, options?: ChatClientOptions): ChatClient
Creates an instance of the ChatClient for a given resource and user.
Parameters
- endpoint: string
  
  The url of the Communication Services resource.
- credential: CommunicationTokenCredential
  
  The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential.
- options: ChatClientOptions = {}
  
  Additional client options.
Returns ChatClient
- Defined in chatClient.ts:63

Methods

createChatThread

createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>
Creates a chat thread. Returns thread client with the id of the created thread.
Parameters
- request: CreateChatThreadRequest
  
  Request for creating a chat thread.
- options: CreateChatThreadOptions = {}
  
  Operation options.
Returns Promise<CreateChatThreadResult>
- Defined in chatClient.ts:114

deleteChatThread

deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>
Deletes a chat thread.
Parameters
- threadId: string
  
  The ID of the thread to delete.
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatClient.ts:211

getChatThreadClient

getChatThreadClient(threadId: string): ChatThreadClient
Returns ChatThreadClient with the specific thread id.
Parameters
- threadId: string
  
  Thread ID for the ChatThreadClient
Returns ChatThreadClient
- Defined in chatClient.ts:104

listChatThreads

listChatThreads(options?: RestListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadItem>
Gets the list of chat threads of a user.
Parameters
- options: RestListChatThreadsOptions = {}
  
  List chat threads options.
Returns PagedAsyncIterableIterator<ChatThreadItem>
- Defined in chatClient.ts:178

off

off(event: "chatMessageReceived", listener: ((e: ChatMessageReceivedEvent) => void)): void
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:373
off(event: "chatMessageEdited", listener: ((e: ChatMessageEditedEvent) => void)): void
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:380
off(event: "chatMessageDeleted", listener: ((e: ChatMessageDeletedEvent) => void)): void
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:387
off(event: "typingIndicatorReceived", listener: ((e: TypingIndicatorReceivedEvent) => void)): void
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:394
off(event: "readReceiptReceived", listener: ((e: ReadReceiptReceivedEvent) => void)): void
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:404
off(event: "chatThreadCreated", listener: ((e: ChatThreadCreatedEvent) => void)): void
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:411
off(event: "chatThreadDeleted", listener: ((e: ChatThreadDeletedEvent) => void)): void
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:418
off(event: "chatThreadPropertiesUpdated", listener: ((e: ChatThreadPropertiesUpdatedEvent) => void)): void
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:425
off(event: "participantsAdded", listener: ((e: ParticipantsAddedEvent) => void)): void
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:435
off(event: "participantsRemoved", listener: ((e: ParticipantsRemovedEvent) => void)): void
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
- Defined in chatClient.ts:442

on

on(event: "chatMessageReceived", listener: ((e: ChatMessageReceivedEvent) => void)): void
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:263
on(event: "chatMessageEdited", listener: ((e: ChatMessageEditedEvent) => void)): void
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:271
on(event: "chatMessageDeleted", listener: ((e: ChatMessageDeletedEvent) => void)): void
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:279
on(event: "typingIndicatorReceived", listener: ((e: TypingIndicatorReceivedEvent) => void)): void
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:287
on(event: "readReceiptReceived", listener: ((e: ReadReceiptReceivedEvent) => void)): void
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:297
on(event: "chatThreadCreated", listener: ((e: ChatThreadCreatedEvent) => void)): void
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:304
on(event: "chatThreadDeleted", listener: ((e: ChatThreadDeletedEvent) => void)): void
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:311
on(event: "chatThreadPropertiesUpdated", listener: ((e: ChatThreadPropertiesUpdatedEvent) => void)): void
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:318
on(event: "participantsAdded", listener: ((e: ParticipantsAddedEvent) => void)): void
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:328
on(event: "participantsRemoved", listener: ((e: ParticipantsRemovedEvent) => void)): void
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
- Defined in chatClient.ts:335
on(event: "realTimeNotificationConnected", listener: (() => void)): void
Subscribe function for realTimeNotificationConnected.
Parameters
- event: "realTimeNotificationConnected"
  
  The realTimeNotificationConnected Event
- listener: (() => void)
  
  The listener to handle the event.
  - - (): void
    - Returns void
Returns void
- Defined in chatClient.ts:342
on(event: "realTimeNotificationDisconnected", listener: (() => void)): void
Subscribe function for realTimeNotificationDisconnected.
Parameters
- event: "realTimeNotificationDisconnected"
  
  The realTimeNotificationDisconnected Event
- listener: (() => void)
  
  The listener to handle the event.
  - - (): void
    - Returns void
Returns void
- Defined in chatClient.ts:349

startRealtimeNotifications

startRealtimeNotifications(): Promise<void>
Start receiving realtime notifications. Call this function before subscribing to any event.

Returns Promise<void>
- Defined in chatClient.ts:228

stopRealtimeNotifications

stopRealtimeNotifications(): Promise<void>
Stop receiving realtime notifications. This function would unsubscribe to all events.

Returns Promise<void>
- Defined in chatClient.ts:246

Class ChatClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

endpoint: string

credential: CommunicationTokenCredential

options: ChatClientOptions = {}

Returns ChatClient

Methods

createChatThread

Parameters

request: CreateChatThreadRequest

options: CreateChatThreadOptions = {}

Returns Promise<CreateChatThreadResult>

deleteChatThread

Parameters

threadId: string

options: OperationOptions = {}

Returns Promise<void>

getChatThreadClient

Parameters

threadId: string

Returns ChatThreadClient

listChatThreads

Parameters

options: RestListChatThreadsOptions = {}

Returns PagedAsyncIterableIterator<ChatThreadItem>

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"

listener: ((e: ChatThreadDeletedEvent) => void)

Parameters

e: ChatThreadDeletedEvent

Returns void