@azure-rest/communication-messages package

Interfaces

AudioNotificationContent	Demande d’envoi d’une notification audio.
DocumentNotificationContent	Demande d’envoi d’une notification de document.
GetMedia
GetMedia200Headers
GetMedia200Response	La demande a réussi.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Demande d’envoi d’une notification d’image.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	La demande a réussi.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Réception de l’envoi d’un message.
MessageTemplate	Objet de modèle utilisé pour créer des modèles.
MessageTemplateBindingsParent	Objet de liaison pour lier des valeurs à des emplacements spécifiques au modèle
MessageTemplateDocument	Informations sur la valeur du document du modèle de message.
MessageTemplateImage	Informations sur la valeur de l’image du modèle de message.
MessageTemplateItemOutputParent	Modèle de message retourné par le service.
MessageTemplateLocation	Informations sur la valeur d’emplacement du modèle de message.
MessageTemplateQuickAction	Informations sur la valeur d’action rapide du modèle de message.
MessageTemplateText	Informations sur la valeur de texte du modèle de message.
MessageTemplateValueParent	La classe décrit un paramètre d’un modèle.
MessageTemplateVideo	Informations sur la valeur vidéo du modèle de message.
MessagesServiceClientOptions	Paramètres facultatifs pour le client
NotificationContentParent	Détails du message à envoyer.
PagingOptions	Options de l’assistance de pagination
Routes
Send
Send202Headers
Send202Response	La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Résultat de l’opération d’envoi de message.
TemplateNotificationContent	Demande d’envoi d’une notification de modèle.
TextNotificationContent	Demande d’envoi d’une notification texte.
VideoNotificationContent	Demande d’envoi d’une notification vidéo.
WhatsAppMessageTemplateBindings	Liaisons de modèle pour WhatsApp
WhatsAppMessageTemplateBindingsButton	Bouton du composant liaisons de modèle pour WhatsApp
WhatsAppMessageTemplateBindingsComponent	Composant liaisons de modèle pour WhatsApp
WhatsAppMessageTemplateItemOutput	Contrat de réponse de modèle spécifique à WhatsApp

Alias de type

CommunicationMessageKind	Alias pour CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias pour CommunicationMessagesChannelOutput
GetArrayType	Type d’assistance pour extraire le type d’un tableau
GetMediaParameters
GetPage	Type d’une fonction personnalisée qui définit comment obtenir une page et un lien vers le suivant, le cas échéant.
ListTemplatesParameters
MessageTemplateBindings	Objet de liaison pour lier des valeurs à des emplacements spécifiques au modèle
MessageTemplateBindingsKind	Alias pour MessageTemplateBindingsKind
MessageTemplateItemOutput	Modèle de message retourné par le service.
MessageTemplateStatusOutput	Alias pour MessageTemplateStatusOutput
MessageTemplateValue	La classe décrit un paramètre d’un modèle.
MessageTemplateValueKind	Alias pour MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Détails du message à envoyer.
PagedMessageTemplateItemOutput	Collection paginée d’éléments MessageTemplateItem
PaginateReturn	Type d’assistance pour déduire le type des éléments paginés à partir du type de réponse Ce type est généré en fonction des informations swagger pour x-ms-pageable spécifiquement sur la propriété itemName qui indique la propriété de la réponse où les éléments de page sont trouvés. La valeur par défaut est value. Ce type nous permettra de fournir un itérateur fortement typé en fonction de la réponse que nous obtenons en tant que deuxième paramètre
RepeatabilityResultOutput	Alias pour RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias pour WhatsAppMessageButtonSubType

Functions

default(string, ClientOptions)	Initialiser une nouvelle instance de MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Initialiser une nouvelle instance de MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Assistance pour paginer les résultats d’une réponse initiale qui suit la spécification de l’extension autorest x-ms-pageable

Informations relatives à la fonction

default(string, ClientOptions)

Initialiser une nouvelle instance de MessagesServiceClient

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

Paramètres

connectionString

string

ConnectionString ou URL de votre ressource Communication Services.

options

ClientOptions

paramètre de tous les paramètres facultatifs

Retours

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Initialiser une nouvelle instance de MessagesServiceClient

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

Paramètres

endpoint

string

Point de terminaison de votre ressource Communication Services.

credential

KeyCredential | TokenCredential

Informations d’identification de clé ou de jeton.

options

ClientOptions

paramètre de tous les paramètres facultatifs

Retours

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Paramètres

response

GetMedia200Response | GetMediaDefaultResponse

Retours

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Paramètres

response

Send202Response | SendDefaultResponse

Retours

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Paramètres

response

ListTemplates200Response | ListTemplatesDefaultResponse

Retours

response

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

Assistance pour paginer les résultats d’une réponse initiale qui suit la spécification de l’extension autorest x-ms-pageable

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

Paramètres

client

Client

Client à utiliser pour envoyer les demandes de page suivantes

initialResponse

TResponse

Réponse initiale contenant la page nextLink et active des éléments

options

PagingOptions<TResponse>

Retours

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator pour itérer les éléments