ChatClient class

Paket:

@azure/communication-chat

Sohbet işlemlerini yapmak için istemci

Oluşturucular

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Belirli bir kaynak ve kullanıcı için ChatClient örneğini oluşturur.

Yöntemler

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Sohbet yazışması oluşturur. Oluşturulan iş parçacığının kimliğine sahip iş parçacığı istemcisini döndürür.
deleteChatThread(string, OperationOptions)	Sohbet yazışmalarını siler.
getChatThreadClient(string)	Belirli iş parçacığı kimliğine sahip ChatThreadClient döndürür.
listChatThreads(ChatListChatThreadsOptionalParams)	Kullanıcının sohbet yazışmalarının listesini alır.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted aboneliğini kaldırın.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited aboneliğini kaldırın.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived aboneliğini kaldırın.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated aboneliğini kaldırın.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted aboneliğini kaldırın.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated aboneliğini kaldırın.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Katılımcı aboneliğini kaldırmaAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Katılımcılardan aboneliği kaldırmaYenilendi.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived aboneliğini kaldırın.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	typingIndicatorReceived aboneliğini kaldırın.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted için Subscribe işlevi. İlk gönderen de bu olayı alır.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited için Subscribe işlevi. İlk gönderen de bu olayı alır.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived için Subscribe işlevi. İlk gönderen de bu olayı alır. Herhangi bir olaya abone olmadan önce startRealtimeNotifications çağrısı yapmanız gerekir.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated için Subscribe işlevi.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted için Subscribe işlevi.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated için Subscribe işlevi.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Katılımcılar için Subscribe işleviAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	ParticipantsRemoved için Subscribe işlevi.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived için Subscribe işlevi.
on("realTimeNotificationConnected", () => void)	realTimeNotificationConnected için Subscribe işlevi.
on("realTimeNotificationDisconnected", () => void)	realTimeNotificationDisconnected için Subscribe işlevi.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	subscribeIndicatorReceived işlevi. İlk gönderen de bu olayı alır.
startRealtimeNotifications()	Gerçek zamanlı bildirimler almaya başlayın. Herhangi bir olaya abone olmadan önce bu işlevi çağır.
stopRealtimeNotifications()	Gerçek zamanlı bildirimleri almayı durdurun. Bu işlev tüm olayların aboneliğini kaldıracak.

Oluşturucu Ayrıntıları

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Belirli bir kaynak ve kullanıcı için ChatClient örneğini oluşturur.

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

Parametreler

endpoint

string

İletişim Hizmetleri kaynağının URL'si.

credential

CommunicationTokenCredential

Belirteç kimlik bilgileri. Kimlik bilgisi oluşturmak için @azure/communication-common azurecommunicationTokenCredential komutunu kullanın.

options

ChatClientOptions

Ek istemci seçenekleri.

Yöntem Ayrıntıları

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Sohbet yazışması oluşturur. Oluşturulan iş parçacığının kimliğine sahip iş parçacığı istemcisini döndürür.

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

Parametreler

request

CreateChatThreadRequest

Sohbet yazışması oluşturma isteği.

options

CreateChatThreadOptions

İşlem seçenekleri.

Döndürülenler

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Sohbet yazışmalarını siler.

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

Parametreler

threadId

string

Silinecek iş parçacığının kimliği.

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

getChatThreadClient(string)

Belirli iş parçacığı kimliğine sahip ChatThreadClient döndürür.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametreler

threadId

string

ChatThreadClient için İş Parçacığı Kimliği

Döndürülenler

ChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Kullanıcının sohbet yazışmalarının listesini alır.

function listChatThreads(options?: ChatListChatThreadsOptionalParams): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Parametreler

options

RestListChatThreadsOptions

Sohbet yazışmaları seçeneklerini listeleyin.

Döndürülenler

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

chatMessageDeleted aboneliğini kaldırın.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Parametreler

event

"chatMessageDeleted"

ChatMessageDeletedOlayı.

listener

(e: ChatMessageDeletedEvent) => void

Olayı işlemek için dinleyici.

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

chatMessageEdited aboneliğini kaldırın.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Parametreler

event

"chatMessageEdited"

ChatMessageEditedOlayı.

listener

(e: ChatMessageEditedEvent) => void

Olayı işlemek için dinleyici.

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

chatMessageReceived aboneliğini kaldırın.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Parametreler

event

"chatMessageReceived"

ChatMessageReceivedOlayı.

listener

(e: ChatMessageReceivedEvent) => void

Olayı işlemek için dinleyici.

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

chatThreadCreated aboneliğini kaldırın.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Parametreler

event

"chatThreadCreated"

ChatThreadCreatedOlayı.

listener

(e: ChatThreadCreatedEvent) => void

Olayı işlemek için dinleyici.

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

chatThreadDeleted aboneliğini kaldırın.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Parametreler

event

"chatThreadDeleted"

ChatThreadDeletedOlayı.

listener

(e: ChatThreadDeletedEvent) => void

Olayı işlemek için dinleyici.

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

chatThreadPropertiesUpdated aboneliğini kaldırın.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Parametreler

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Olayı işlemek için dinleyici.

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

Katılımcı aboneliğini kaldırmaAdded.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Parametreler

event

"participantsAdded"

KatılımcılarEklendiOlayı.

listener

(e: ParticipantsAddedEvent) => void

Olayı işlemek için dinleyici.

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Katılımcılardan aboneliği kaldırmaYenilendi.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Parametreler

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Olayı işlemek için dinleyici.

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

readReceiptReceived aboneliğini kaldırın.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Parametreler

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Olayı işlemek için dinleyici.

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

typingIndicatorReceived aboneliğini kaldırın.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Parametreler

event

"typingIndicatorReceived"

TypingIndicatorReceivedOlayı.

listener

(e: TypingIndicatorReceivedEvent) => void

Olayı işlemek için dinleyici.

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

chatMessageDeleted için Subscribe işlevi. İlk gönderen de bu olayı alır.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Parametreler

event

"chatMessageDeleted"

ChatMessageDeletedOlayı.

listener

(e: ChatMessageDeletedEvent) => void

Olayı işlemek için dinleyici.

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

chatMessageEdited için Subscribe işlevi. İlk gönderen de bu olayı alır.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Parametreler

event

"chatMessageEdited"

ChatMessageEditedOlayı.

listener

(e: ChatMessageEditedEvent) => void

Olayı işlemek için dinleyici.

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

chatMessageReceived için Subscribe işlevi. İlk gönderen de bu olayı alır. Herhangi bir olaya abone olmadan önce startRealtimeNotifications çağrısı yapmanız gerekir.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Parametreler

event

"chatMessageReceived"

ChatMessageReceivedOlayı.

listener

(e: ChatMessageReceivedEvent) => void

Olayı işlemek için dinleyici.

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

chatThreadCreated için Subscribe işlevi.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Parametreler

event

"chatThreadCreated"

ChatThreadCreatedOlayı.

listener

(e: ChatThreadCreatedEvent) => void

Olayı işlemek için dinleyici.

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

chatThreadDeleted için Subscribe işlevi.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Parametreler

event

"chatThreadDeleted"

ChatThreadDeletedOlayı.

listener

(e: ChatThreadDeletedEvent) => void

Olayı işlemek için dinleyici.

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

chatThreadPropertiesUpdated için Subscribe işlevi.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Parametreler

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Olayı işlemek için dinleyici.

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

Katılımcılar için Subscribe işleviAdded.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Parametreler

event

"participantsAdded"

KatılımcılarEklendiOlayı.

listener

(e: ParticipantsAddedEvent) => void

Olayı işlemek için dinleyici.

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

ParticipantsRemoved için Subscribe işlevi.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Parametreler

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Olayı işlemek için dinleyici.

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

readReceiptReceived için Subscribe işlevi.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Parametreler

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Olayı işlemek için dinleyici.

on("realTimeNotificationConnected", () => void)

realTimeNotificationConnected için Subscribe işlevi.

function on(event: "realTimeNotificationConnected", listener: () => void)

Parametreler

event

"realTimeNotificationConnected"

realTimeNotificationConnected Olayı

listener

() => void

Olayı işlemek için dinleyici.

on("realTimeNotificationDisconnected", () => void)

realTimeNotificationDisconnected için Subscribe işlevi.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

Parametreler

event

"realTimeNotificationDisconnected"

realTimeNotificationDisconnected Olayı

listener

() => void

Olayı işlemek için dinleyici.

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

subscribeIndicatorReceived işlevi. İlk gönderen de bu olayı alır.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Parametreler

event

"typingIndicatorReceived"

TypingIndicatorReceivedOlayı.

listener

(e: TypingIndicatorReceivedEvent) => void

Olayı işlemek için dinleyici.

startRealtimeNotifications()

Gerçek zamanlı bildirimler almaya başlayın. Herhangi bir olaya abone olmadan önce bu işlevi çağır.

function startRealtimeNotifications(): Promise<void>

Döndürülenler

Promise<void>

stopRealtimeNotifications()

Gerçek zamanlı bildirimleri almayı durdurun. Bu işlev tüm olayların aboneliğini kaldıracak.

function stopRealtimeNotifications(): Promise<void>

Döndürülenler

Promise<void>