@azure-rest/communication-messages package

Interfaces

AudioNotificationContent	Een aanvraag om een audiomelding te verzenden.
DocumentNotificationContent	Een aanvraag om een documentmelding te verzenden.
GetMedia
GetMedia200Headers
GetMedia200Response	De aanvraag is voltooid.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Een aanvraag voor het verzenden van een afbeeldingsmelding.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	De aanvraag is voltooid.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Ontvangst van het verzenden van één bericht.
MessageTemplate	Het sjabloonobject dat wordt gebruikt om sjablonen te maken.
MessageTemplateBindingsParent	Het bindingsobject om waarden te koppelen aan de sjabloonspecifieke locaties
MessageTemplateDocument	De documentwaardegegevens van de berichtsjabloon.
MessageTemplateImage	De waardegegevens van de afbeeldingswaarde van de berichtsjabloon.
MessageTemplateItemOutputParent	De berichtsjabloon zoals geretourneerd door de service.
MessageTemplateLocation	De locatiewaardegegevens van de berichtsjabloon.
MessageTemplateQuickAction	De informatie over de snelle actiewaarde van de berichtsjabloon.
MessageTemplateText	De tekstwaardegegevens van de berichtsjabloon.
MessageTemplateValueParent	In de klasse wordt een parameter van een sjabloon beschreven.
MessageTemplateVideo	De informatie over de videowaarde van de berichtsjabloon.
MessagesServiceClientOptions	De optionele parameters voor de client
NotificationContentParent	Details van het te verzenden bericht.
PagingOptions	Opties voor de helper voor paging
Routes
Send
Send202Headers
Send202Response	De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Resultaat van de verzendberichtbewerking.
TemplateNotificationContent	Een aanvraag voor het verzenden van een sjabloonmelding.
TextNotificationContent	Een verzoek om een sms-melding te verzenden.
VideoNotificationContent	Een aanvraag voor het verzenden van een videomelding.
WhatsAppMessageTemplateBindings	De sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsButton	De componentknop sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsComponent	Het component sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateItemOutput	Het antwoordcontract voor whatsApp-specifieke sjabloon

Type-aliassen

CommunicationMessageKind	Alias voor CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias voor CommunicationMessagesChannelOutput
GetArrayType	Helpertype voor het extraheren van het type matrix
GetMediaParameters
GetPage	Het type aangepaste functie waarmee wordt gedefinieerd hoe u een pagina en een koppeling naar de volgende krijgt, indien van toepassing.
ListTemplatesParameters
MessageTemplateBindings	Het bindingsobject om waarden te koppelen aan de sjabloonspecifieke locaties
MessageTemplateBindingsKind	Alias voor MessageTemplateBindingsKind
MessageTemplateItemOutput	De berichtsjabloon zoals geretourneerd door de service.
MessageTemplateStatusOutput	Alias voor MessageTemplateStatusOutput
MessageTemplateValue	In de klasse wordt een parameter van een sjabloon beschreven.
MessageTemplateValueKind	Alias voor MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Details van het te verzenden bericht.
PagedMessageTemplateItemOutput	Gepaginade verzameling MessageTemplateItem-items
PaginateReturn	Helpertype voor het afleiden van het type gepaginade elementen van het antwoordtype Dit type wordt gegenereerd op basis van de swagger-informatie voor x-ms-pageable specifiek op de eigenschap itemName die de eigenschap aangeeft van het antwoord waarin de pagina-items worden gevonden. De standaardwaarde is value. Met dit type kunnen we sterk getypte Iterator opgeven op basis van het antwoord dat we krijgen als tweede parameter
RepeatabilityResultOutput	Alias voor RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias voor WhatsAppMessageButtonSubType

Functies

default(string, ClientOptions)	Een nieuw exemplaar van MessagesServiceClient initialiseren
default(string, KeyCredential | TokenCredential, ClientOptions)	Een nieuw exemplaar van MessagesServiceClient initialiseren
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper voor het pagineren van resultaten van een eerste antwoord dat volgt op de specificatie van autorest x-ms-pageable-extensie

Functiedetails

default(string, ClientOptions)

Een nieuw exemplaar van MessagesServiceClient initialiseren

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

Parameters

connectionString

string

De connectionString of URL van uw Communication Services-resource.

options

ClientOptions

de parameter voor alle optionele parameters

Retouren

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Een nieuw exemplaar van MessagesServiceClient initialiseren

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

Parameters

endpoint

string

Het eindpunt van uw Communication Services-resource.

credential

KeyCredential | TokenCredential

De sleutel- of tokenreferentie.

options

ClientOptions

de parameter voor alle optionele parameters

Retouren

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parameters

response

GetMedia200Response | GetMediaDefaultResponse

Retouren

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parameters

response

Send202Response | SendDefaultResponse

Retouren

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parameters

response

ListTemplates200Response | ListTemplatesDefaultResponse

Retouren

response

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

Helper voor het pagineren van resultaten van een eerste antwoord dat volgt op de specificatie van autorest x-ms-pageable-extensie

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

Parameters

client

Client

Client die moet worden gebruikt voor het verzenden van de volgende paginaaanvragen

initialResponse

TResponse

Eerste antwoord met de nextLink en de huidige pagina met elementen

options

PagingOptions<TResponse>

Retouren

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator om de elementen te herhalen