Delen via

@azure-rest/communication-messages package

  • Referentie

Interfaces

ClientRequestIdHeaderOutput

Biedt de header 'x-ms-client-request-id' om aanvraagcorrelatie in te schakelen in aanvragen en antwoorden.
GetMedia
GetMedia200Headers
GetMedia200Response

De aanvraag is geslaagd.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ListTemplates
ListTemplates200Headers
ListTemplates200Response

De aanvraag is geslaagd.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent

Een aanvraag voor het verzenden van een mediamelding.
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 informatie over de documentwaarde van de berichtsjabloon.
MessageTemplateImage

Informatie over de afbeeldingswaarde van de berichtsjabloon.
MessageTemplateItemOutputParent

De berichtsjabloon zoals geretourneerd door de service.
MessageTemplateLocation

Informatie over de locatiewaarde van de berichtsjabloon.
MessageTemplateQuickAction

De informatie over de waarde van de snelle actie van de berichtsjabloon.
MessageTemplateText

De tekstwaardegegevens van de berichtsjabloon.
MessageTemplateValueParent

De klasse beschrijft een parameter van een sjabloon.
MessageTemplateVideo

De videowaardegegevens van de berichtsjabloon.
NotificationContentParent

Details van het bericht dat moet worden verzonden.
PagingOptions

Opties voor de paging-helper
RepeatabilityRequestHeadersOutput

Biedt de headers 'Herhaalbaarheid-*' om herhaalbare aanvragen in te schakelen.
RepeatabilityResponseHeadersOutput

Biedt de headers 'Herhaalbaarheid-*' om herhaalbare aanvragen in te schakelen.
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 verzendbewerking.
TemplateNotificationContent

Een aanvraag voor het verzenden van een sjabloonmelding.
TextNotificationContent

Een verzoek om een sms-melding te verzenden.
WhatsAppMessageTemplateBindings

De sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsButton

De onderdeelknop sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsComponent

Het onderdeel sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateItemOutput

Het WhatsApp-specifieke sjabloonantwoordcontract

Type-aliassen

GetArrayType

Helpertype om het type van een matrix te extraheren
GetMediaParameters
GetPage

Het type aangepaste functie waarmee wordt gedefinieerd hoe u een pagina en een koppeling naar de volgende pagina kunt ophalen, indien van toepassing.
ListTemplatesParameters
MessageTemplateBindings

Het bindingsobject om waarden te koppelen aan de sjabloonspecifieke locaties
MessageTemplateItemOutput

De berichtsjabloon zoals geretourneerd door de service.
MessageTemplateValue

De klasse beschrijft een parameter van een sjabloon.
MessagesServiceClient
NotificationContent

Details van het bericht dat moet worden verzonden.
PagedMessageTemplateItemOutput

Gepaginade verzameling MessageTemplateItem-items
PaginateReturn

Helpertype om het Type van de wisselbare elementen af te maken van het antwoordtype Dit type wordt gegenereerd op basis van de swagger-informatie voor x-ms-pageable specifiek op de eigenschap itemName, waarmee de eigenschap wordt aangegeven van het antwoord waar de pagina-items zich bevinden. 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

Functies

default(string, ClientOptions)

Initialiseer een nieuw exemplaar van MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)

Initialiseer een nieuw exemplaar van MessagesServiceClient
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 de specificatie van de Autorest-extensie x-ms-pageable volgt

Functiedetails

default(string, ClientOptions)

Initialiseer een nieuw exemplaar van MessagesServiceClient

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)

Initialiseer een nieuw exemplaar van MessagesServiceClient

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 de specificatie van de Autorest-extensie x-ms-pageable volgt

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 aanvragen voor de volgende pagina

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