ChatAdapterThreadManagement interface

パッケージ:

@azure/communication-react

現在のチャット スレッドを管理するための機能。

メソッド

deleteMessage(string)	スレッド内のメッセージを削除します。
downloadResourceToCache(ResourceDetails)	指定されたメッセージのリソースをキャッシュにダウンロードします。
fetchInitialData()	チャット アダプターの初期状態をフェッチします。 ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。
loadPreviousChatMessages(number)	チャット スレッド履歴に以前のメッセージをさらに読み込みます。
removeParticipant(string)	スレッド内の参加者を削除します。
removeResourceFromCache(ResourceDetails)	指定したメッセージのキャッシュからリソースを削除します。
sendMessage(string, SendMessageOptions)	スレッドでメッセージを送信します。 SendMessageOptionsは非推奨となりますので、MessageOptionsをご利用ください。
sendReadReceipt(string)	メッセージの開封確認メッセージを送信します。
sendTypingIndicator()	スレッドで入力インジケーターを送信します。
setTopic(string)	スレッドのトピックを設定します。
updateMessage(string, string, Record<string, string>)	メッセージの内容を更新します。 メタデータは非推奨になるので、代わりにMessageOptions.metadataを使用してください。

メソッドの詳細

deleteMessage(string)

スレッド内のメッセージを削除します。

function deleteMessage(messageId: string): Promise<void>

パラメーター

messageId

string

戻り値

Promise<void>

downloadResourceToCache(ResourceDetails)

指定されたメッセージのリソースをキャッシュにダウンロードします。

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

パラメーター

resourceDetails

ResourceDetails

戻り値

Promise<void>

fetchInitialData()

チャット アダプターの初期状態をフェッチします。

ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。

function fetchInitialData(): Promise<void>

戻り値

Promise<void>

loadPreviousChatMessages(number)

チャット スレッド履歴に以前のメッセージをさらに読み込みます。

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

パラメーター

messagesToLoad

number

戻り値

Promise<boolean>

注釈

このメソッドは通常、増分フェッチ/無限スクロールを制御するために使用されます

removeParticipant(string)

スレッド内の参加者を削除します。

function removeParticipant(userId: string): Promise<void>

パラメーター

userId

string

戻り値

Promise<void>

removeResourceFromCache(ResourceDetails)

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

function removeResourceFromCache(resourceDetails: ResourceDetails)

パラメーター

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

スレッドでメッセージを送信します。 SendMessageOptionsは非推奨となりますので、MessageOptionsをご利用ください。

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

パラメーター

content

string

options

SendMessageOptions

戻り値

Promise<void>

sendReadReceipt(string)

メッセージの開封確認メッセージを送信します。

function sendReadReceipt(chatMessageId: string): Promise<void>

パラメーター

chatMessageId

string

戻り値

Promise<void>

sendTypingIndicator()

スレッドで入力インジケーターを送信します。

function sendTypingIndicator(): Promise<void>

戻り値

Promise<void>

setTopic(string)

スレッドのトピックを設定します。

function setTopic(topicName: string): Promise<void>

パラメーター

topicName

string

戻り値

Promise<void>

updateMessage(string, string, Record<string, string>)

メッセージの内容を更新します。 メタデータは非推奨になるので、代わりにMessageOptions.metadataを使用してください。

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

パラメーター

messageId

string

content

string

options

Record<string, string>

戻り値

Promise<void>