StatefulChatClient interface

パッケージ:

@azure/communication-react

{@Link @azure/communication-chat#ChatClient}を一元的に生成された状態で使用できるようにするメソッドを定義します。

インターフェイスは、プロキシされた状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。

Extends

ChatClient

メソッド

dispose()	チャット・スレッド・クライアントからリソース・キャッシュをクリーンアップします。
downloadResourceToCache(string, string, string)	特定のメッセージのリソースをダウンロードし、キャッシュします。
getState()	ChatClient {@Link @azure/communication-chat#ChatClient} から ChatClientState {@Link ChatClientState} としてプロキシできるすべての状態を保持します。
offStateChange((state: ChatClientState) => void)	'stateChanged' イベントの登録解除を許可します。
onStateChange((state: ChatClientState) => void)	ハンドラーを 'stateChanged' イベントに登録できるようにします。
removeResourceFromCache(string, string, string)	特定のメッセージのキャッシュからリソースを削除します。

継承されたメソッド

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	チャット スレッドを作成します。 作成されたスレッドの ID を持つスレッド クライアントを返します。
deleteChatThread(string, OperationOptions)	チャット スレッドを削除します。
getChatThreadClient(string)	特定のスレッド ID を持つ ChatThreadClient を返します。
listChatThreads(ChatListChatThreadsOptionalParams)	ユーザーのチャット スレッドの一覧を取得します。
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted のサブスクライブを解除します。
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited の登録を解除します。
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived の登録を解除します。
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated の登録を解除します。
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted の登録を解除します。
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated のサブスクライブを解除します。
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	participantsAdded からサブスクライブを解除します。
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	participantsRemoved からサブスクライブを解除します。
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived のサブスクライブを解除します。
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	TypingIndicatorReceived の登録を解除します。
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted のサブスクライブ関数。 最初の送信者もこのイベントを受け取ります。
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited の Subscribe 関数。 最初の送信者もこのイベントを受け取ります。
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived の Subscribe 関数。 最初の送信者もこのイベントを受け取ります。 イベントをサブスクライブする前に、startRealtimeNotifications を呼び出す必要があります。
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated のサブスクライブ関数。
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted のサブスクライブ関数。
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated の Subscribe 関数。
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	participantsAdded のサブスクライブ関数。
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	participantsRemoved のサブスクライブ関数。
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived のサブスクライブ関数。
on("realTimeNotificationConnected", () => void)	realTimeNotificationConnected のサブスクライブ関数。
on("realTimeNotificationDisconnected", () => void)	realTimeNotificationDisconnected のサブスクライブ関数。
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	「IndicatorReceived」と入力するための Subscribe 関数。 最初の送信者もこのイベントを受け取ります。
startRealtimeNotifications()	リアルタイム通知の受信を開始します。 イベントをサブスクライブする前に、この関数を呼び出します。
stopRealtimeNotifications()	リアルタイム通知の受信を停止します。 この関数は、すべてのイベントのサブスクライブを解除します。

メソッドの詳細

dispose()

チャット・スレッド・クライアントからリソース・キャッシュをクリーンアップします。

function dispose()

downloadResourceToCache(string, string, string)

特定のメッセージのリソースをダウンロードし、キャッシュします。

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

パラメーター

threadId

string

チャット スレッドのスレッド ID。

messageId

string

チャット メッセージのメッセージ ID。

resourceUrl

string

フェッチしてキャッシュするリソースの URL。

getState()

ChatClient {@Link @azure/communication-chat#ChatClient} から ChatClientState {@Link ChatClientState} としてプロキシできるすべての状態を保持します。

function getState(): ChatClientState

戻り値

ChatClientState

offStateChange((state: ChatClientState) => void)

'stateChanged' イベントの登録解除を許可します。

function offStateChange(handler: (state: ChatClientState) => void)

パラメーター

handler

(state: ChatClientState) => void

サブスクリプションを解除する元のコールバック。

onStateChange((state: ChatClientState) => void)

ハンドラーを 'stateChanged' イベントに登録できるようにします。

function onStateChange(handler: (state: ChatClientState) => void)

パラメーター

handler

(state: ChatClientState) => void

状態を受け取るコールバック。

removeResourceFromCache(string, string, string)

特定のメッセージのキャッシュからリソースを削除します。

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

パラメーター

threadId

string

チャット スレッドのスレッド ID。

messageId

string

チャット メッセージのメッセージ ID。

resourceUrl

string

キャッシュから削除するリソースの URL。

継承済みメソッドの詳細

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

チャット スレッドを作成します。 作成されたスレッドの ID を持つスレッド クライアントを返します。

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

パラメーター

request

CreateChatThreadRequest

チャット スレッドを作成するための要求。

options

CreateChatThreadOptions

操作オプション。

戻り値

Promise<CreateChatThreadResult>

ChatClient.createChatThread から継承された

deleteChatThread(string, OperationOptions)

チャット スレッドを削除します。

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

パラメーター

threadId

string

削除するスレッドの ID。

options

OperationOptions

操作オプション。

戻り値

Promise<void>

ChatClient.deleteChatThread から継承された

getChatThreadClient(string)

特定のスレッド ID を持つ ChatThreadClient を返します。

function getChatThreadClient(threadId: string): ChatThreadClient

パラメーター

threadId

string

ChatThreadClient のスレッド ID

戻り値

ChatThreadClient

ChatClient.getChatThreadClient から継承された

listChatThreads(ChatListChatThreadsOptionalParams)

ユーザーのチャット スレッドの一覧を取得します。

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

パラメーター

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

チャット スレッドのオプションを一覧表示します。

戻り値

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

ChatClient.listChatThreads から継承された

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

chatMessageDeleted のサブスクライブを解除します。

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

パラメーター

event

"chatMessageDeleted"

ChatMessageDeletedEvent。

listener

(e: ChatMessageDeletedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatMessageEdited の登録を解除します。

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

パラメーター

event

"chatMessageEdited"

ChatMessageEditedEvent。

listener

(e: ChatMessageEditedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatMessageReceived の登録を解除します。

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

パラメーター

event

"chatMessageReceived"

ChatMessageReceivedEvent。

listener

(e: ChatMessageReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatThreadCreated の登録を解除します。

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

パラメーター

event

"chatThreadCreated"

ChatThreadCreatedEvent。

listener

(e: ChatThreadCreatedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatThreadDeleted の登録を解除します。

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

パラメーター

event

"chatThreadDeleted"

ChatThreadDeletedEvent。

listener

(e: ChatThreadDeletedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatThreadPropertiesUpdated のサブスクライブを解除します。

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

パラメーター

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent。

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

participantsAdded からサブスクライブを解除します。

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

パラメーター

event

"participantsAdded"

ParticipantsAddedEvent。

listener

(e: ParticipantsAddedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

participantsRemoved からサブスクライブを解除します。

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

パラメーター

event

"participantsRemoved"

ParticipantsRemovedEvent。

listener

(e: ParticipantsRemovedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

readReceiptReceived のサブスクライブを解除します。

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

パラメーター

event

"readReceiptReceived"

ReadReceiptReceivedEvent。

listener

(e: ReadReceiptReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

TypingIndicatorReceived の登録を解除します。

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

パラメーター

event

"typingIndicatorReceived"

TypingIndicatorReceivedEvent。

listener

(e: TypingIndicatorReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.off から継承された

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

chatMessageDeleted のサブスクライブ関数。 最初の送信者もこのイベントを受け取ります。

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

パラメーター

event

"chatMessageDeleted"

ChatMessageDeletedEvent。

listener

(e: ChatMessageDeletedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

chatMessageEdited の Subscribe 関数。 最初の送信者もこのイベントを受け取ります。

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

パラメーター

event

"chatMessageEdited"

ChatMessageEditedEvent。

listener

(e: ChatMessageEditedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

chatMessageReceived の Subscribe 関数。 最初の送信者もこのイベントを受け取ります。 イベントをサブスクライブする前に、startRealtimeNotifications を呼び出す必要があります。

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

パラメーター

event

"chatMessageReceived"

ChatMessageReceivedEvent。

listener

(e: ChatMessageReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

chatThreadCreated のサブスクライブ関数。

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

パラメーター

event

"chatThreadCreated"

ChatThreadCreatedEvent。

listener

(e: ChatThreadCreatedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

chatThreadDeleted のサブスクライブ関数。

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

パラメーター

event

"chatThreadDeleted"

ChatThreadDeletedEvent。

listener

(e: ChatThreadDeletedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

chatThreadPropertiesUpdated の Subscribe 関数。

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

パラメーター

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent。

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

participantsAdded のサブスクライブ関数。

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

パラメーター

event

"participantsAdded"

ParticipantsAddedEvent。

listener

(e: ParticipantsAddedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

participantsRemoved のサブスクライブ関数。

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

パラメーター

event

"participantsRemoved"

ParticipantsRemovedEvent。

listener

(e: ParticipantsRemovedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

readReceiptReceived のサブスクライブ関数。

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

パラメーター

event

"readReceiptReceived"

ReadReceiptReceivedEvent。

listener

(e: ReadReceiptReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

realTimeNotificationConnected のサブスクライブ関数。

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

パラメーター

event

"realTimeNotificationConnected"

realTimeNotificationConnected イベント

listener

() => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

realTimeNotificationDisconnected のサブスクライブ関数。

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

パラメーター

event

"realTimeNotificationDisconnected"

realTimeNotificationDisconnected イベント

listener

() => void

イベントを処理するリスナー。

ChatClient.on から継承された

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

「IndicatorReceived」と入力するための Subscribe 関数。 最初の送信者もこのイベントを受け取ります。

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

パラメーター

event

"typingIndicatorReceived"

TypingIndicatorReceivedEvent。

listener

(e: TypingIndicatorReceivedEvent) => void

イベントを処理するリスナー。

ChatClient.on から継承された

startRealtimeNotifications()

リアルタイム通知の受信を開始します。 イベントをサブスクライブする前に、この関数を呼び出します。

function startRealtimeNotifications(): Promise<void>

戻り値

Promise<void>

ChatClient.startRealtimeNotifications から継承された

stopRealtimeNotifications()

リアルタイム通知の受信を停止します。 この関数は、すべてのイベントのサブスクライブを解除します。

function stopRealtimeNotifications(): Promise<void>

戻り値

Promise<void>

ChatClient.stopRealtimeNotifications から継承された