@azure-rest/communication-messages package

Schnittstellen

AudioNotificationContent	Eine Anforderung zum Senden einer Audiobenachrichtigung.
DocumentNotificationContent	Eine Anforderung zum Senden einer Dokumentbenachrichtigung.
GetMedia
GetMedia200Headers
GetMedia200Response	Die Anforderung ist erfolgreich.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Eine Anforderung zum Senden einer Bildbenachrichtigung.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	Die Anforderung ist erfolgreich.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Bestätigung des Sendens einer Nachricht.
MessageTemplate	Das Vorlagenobjekt, das zum Erstellen von Vorlagen verwendet wird.
MessageTemplateBindingsParent	Das Bindungsobjekt zum Verknüpfen von Werten mit den vorlagenspezifischen Speicherorten
MessageTemplateDocument	Die Dokumentwertinformationen der Nachrichtenvorlage.
MessageTemplateImage	Die Bildwertinformationen der Nachrichtenvorlage.
MessageTemplateItemOutputParent	Die Nachrichtenvorlage, wie sie vom Dienst zurückgegeben wird.
MessageTemplateLocation	Die Standortwertinformationen der Nachrichtenvorlage.
MessageTemplateQuickAction	Die Quick Action Value-Informationen der Nachrichtenvorlage.
MessageTemplateText	Die Textwertinformationen der Nachrichtenvorlage.
MessageTemplateValueParent	Die Klasse beschreibt einen Parameter einer Vorlage.
MessageTemplateVideo	Die Videowertinformationen der Nachrichtenvorlage.
MessagesServiceClientOptions	Die optionalen Parameter für den Client
NotificationContentParent	Details der zu sendenden Nachricht.
PagingOptions	Optionen für das Paging-Hilfsprogramm
Routes
Send
Send202Headers
Send202Response	Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Ergebnis des Sendenachrichtenvorgangs.
TemplateNotificationContent	Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.
TextNotificationContent	Eine Anforderung zum Senden einer Textbenachrichtigung.
VideoNotificationContent	Eine Anforderung zum Senden einer Videobenachrichtigung.
WhatsAppMessageTemplateBindings	Die Vorlagenbindungen für WhatsApp
WhatsAppMessageTemplateBindingsButton	Die Vorlagenbindungskomponentesschaltfläche für WhatsApp
WhatsAppMessageTemplateBindingsComponent	Die Vorlagenbindungskomponente für WhatsApp
WhatsAppMessageTemplateItemOutput	Der Antwortvertrag für WhatsApp-spezifische Vorlagen

Typaliase

CommunicationMessageKind	Alias für CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias für CommunicationMessagesChannelOutput
GetArrayType	Hilfstyp zum Extrahieren des Typs eines Arrays
GetMediaParameters
GetPage	Der Typ einer benutzerdefinierten Funktion, die definiert, wie eine Seite und ein Link zum nächsten abgerufen werden, falls vorhanden.
ListTemplatesParameters
MessageTemplateBindings	Das Bindungsobjekt zum Verknüpfen von Werten mit den vorlagenspezifischen Speicherorten
MessageTemplateBindingsKind	Alias für MessageTemplateBindingsKind
MessageTemplateItemOutput	Die Nachrichtenvorlage, wie sie vom Dienst zurückgegeben wird.
MessageTemplateStatusOutput	Alias für MessageTemplateStatusOutput
MessageTemplateValue	Die Klasse beschreibt einen Parameter einer Vorlage.
MessageTemplateValueKind	Alias für MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Details der zu sendenden Nachricht.
PagedMessageTemplateItemOutput	Paged-Auflistung von MessageTemplateItem-Elementen
PaginateReturn	Hilfstyp zum Ableiten des Typs der seitenseitigen Elemente vom Antworttyp Dieser Typ wird basierend auf den Waggerinformationen für x-ms-pageable speziell auf der itemName-Eigenschaft generiert, die die Eigenschaft der Antwort angibt, in der die Seitenelemente gefunden werden. Der Standardwert ist value. Dieser Typ ermöglicht es uns, stark typierte Iterator basierend auf der Antwort bereitzustellen, die als zweiter Parameter abgerufen wird.
RepeatabilityResultOutput	Alias für RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias für WhatsAppMessageButtonSubType

Functions

default(string, ClientOptions)	Initialisieren einer neuen Instanz von MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Initialisieren einer neuen Instanz von MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die auf die Spezifikation der Erweiterung Autorest x-ms-pageable folgt

Details zur Funktion

default(string, ClientOptions)

Initialisieren einer neuen Instanz von MessagesServiceClient

function default(connectionString: string, options?: ClientOptions): MessagesServiceClient

Parameter

connectionString

string

Die connectionString- oder URL Ihrer Communication Services-Ressource.

options

ClientOptions

der Parameter für alle optionalen Parameter

Gibt zurück

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Initialisieren einer neuen Instanz von MessagesServiceClient

function default(endpoint: string, credential: KeyCredential | TokenCredential, options?: ClientOptions): MessagesServiceClient

Parameter

endpoint

string

Der Endpunkt Ihrer Communication Services-Ressource.

credential

KeyCredential | TokenCredential

Der Schlüssel oder die Tokenanmeldeinformationen.

options

ClientOptions

der Parameter für alle optionalen Parameter

Gibt zurück

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parameter

response

GetMedia200Response | GetMediaDefaultResponse

Gibt zurück

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parameter

response

Send202Response | SendDefaultResponse

Gibt zurück

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parameter

response

ListTemplates200Response | ListTemplatesDefaultResponse

Gibt zurück

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die auf die Spezifikation der Erweiterung Autorest x-ms-pageable folgt

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameter

client

Client

Client, der zum Senden der nächsten Seitenanforderungen verwendet werden soll

initialResponse

TResponse

Ursprüngliche Antwort, die die nextLink- und aktuelle Seite von Elementen enthält

options

PagingOptions<TResponse>

Gibt zurück

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator zum Durchlaufen der Elemente