ChatAdapterThreadManagement interface

Pakket:

@azure/communication-react

Functionaliteit voor het beheren van de huidige chat-thread.

Methoden

deleteMessage(string)	Een bericht in de thread verwijderen.
downloadResourceToCache(ResourceDetails)	Downloadt een bron in de cache voor het gegeven bericht.
fetchInitialData()	Haal de initiële status voor de chatadapter op. Voert de minimale ophaalfunctie uit die nodig is voor ChatComposite- en API-methoden.
loadPreviousChatMessages(number)	Laad meer eerdere berichten in de chatthreadgeschiedenis.
removeParticipant(string)	Een deelnemer in de thread verwijderen.
removeResourceFromCache(ResourceDetails)	Hiermee verwijdert u een bron uit de cache voor het gegeven bericht.
sendMessage(string, SendMessageOptions)	Verzend een bericht in de thread. Houd er rekening mee dat SendMessageOptions wordt afgeschaft, gebruik in plaats daarvan MessageOptions.
sendReadReceipt(string)	Een leesbevestiging voor een bericht verzenden.
sendTypingIndicator()	Indicator voor typen verzenden in de thread.
setTopic(string)	Stel het onderwerp voor de thread in.
updateMessage(string, string, Record<string, string>)	Een berichtinhoud bijwerken. Houd er rekening mee dat metadata wordt afgeschaft, gebruik in plaats daarvan MessageOptions.metadata.

Methodedetails

deleteMessage(string)

Een bericht in de thread verwijderen.

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

Parameters

messageId

string

Retouren

Promise<void>

downloadResourceToCache(ResourceDetails)

Downloadt een bron in de cache voor het gegeven bericht.

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

Parameters

resourceDetails

ResourceDetails

Retouren

Promise<void>

fetchInitialData()

Haal de initiële status voor de chatadapter op.

Voert de minimale ophaalfunctie uit die nodig is voor ChatComposite- en API-methoden.

function fetchInitialData(): Promise<void>

Retouren

Promise<void>

loadPreviousChatMessages(number)

Laad meer eerdere berichten in de chatthreadgeschiedenis.

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

Parameters

messagesToLoad

number

Retouren

Promise<boolean>

Opmerkingen

Deze methode wordt meestal gebruikt om incrementeel ophalen/oneindig schuiven te beheren

removeParticipant(string)

Een deelnemer in de thread verwijderen.

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

Parameters

userId

string

Retouren

Promise<void>

removeResourceFromCache(ResourceDetails)

Hiermee verwijdert u een bron uit de cache voor het gegeven bericht.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parameters

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Verzend een bericht in de thread. Houd er rekening mee dat SendMessageOptions wordt afgeschaft, gebruik in plaats daarvan MessageOptions.

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

Parameters

content

string

options

SendMessageOptions

Retouren

Promise<void>

sendReadReceipt(string)

Een leesbevestiging voor een bericht verzenden.

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

Parameters

chatMessageId

string

Retouren

Promise<void>

sendTypingIndicator()

Indicator voor typen verzenden in de thread.

function sendTypingIndicator(): Promise<void>

Retouren

Promise<void>

setTopic(string)

Stel het onderwerp voor de thread in.

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

Parameters

topicName

string

Retouren

Promise<void>

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

Een berichtinhoud bijwerken. Houd er rekening mee dat metadata wordt afgeschaft, gebruik in plaats daarvan MessageOptions.metadata.

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

Parameters

messageId

string

content

string

options

Record<string, string>

Retouren

Promise<void>