@azure-rest/communication-messages package

Interfaces

AudioNotificationContent	Uma solicitação para enviar uma notificação de áudio.
DocumentNotificationContent	Um pedido para enviar uma notificação de documento.
GetMedia
GetMedia200Headers
GetMedia200Response	O pedido foi bem-sucedido.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Um pedido para enviar uma notificação por imagem.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	O pedido foi bem-sucedido.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Receção da mensagem enviada.
MessageTemplate	O objeto de modelo usado para criar modelos.
MessageTemplateBindingsParent	O objeto de vinculação para vincular valores aos locais específicos do modelo
MessageTemplateDocument	As informações de valor do documento do modelo de mensagem.
MessageTemplateImage	As informações de valor da imagem do modelo de mensagem.
MessageTemplateItemOutputParent	O modelo de mensagem conforme retornado do serviço.
MessageTemplateLocation	As informações de valor de localização do modelo de mensagem.
MessageTemplateQuickAction	Informações de valor de ação rápida do modelo de mensagem.
MessageTemplateText	As informações de valor de texto do modelo de mensagem.
MessageTemplateValueParent	A classe descreve um parâmetro de um modelo.
MessageTemplateVideo	Informações de valor de vídeo do modelo de mensagem.
MessagesServiceClientOptions	Os parâmetros opcionais para o cliente
NotificationContentParent	Detalhes da mensagem a enviar.
PagingOptions	Opções para o auxiliar de paginação
Routes
Send
Send202Headers
Send202Response	O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Resultado da operação de envio de mensagem.
TemplateNotificationContent	Uma solicitação para enviar uma notificação de modelo.
TextNotificationContent	Um pedido para enviar uma notificação de texto.
VideoNotificationContent	Um pedido para enviar uma notificação de vídeo.
WhatsAppMessageTemplateBindings	As ligações de modelo para o WhatsApp
WhatsAppMessageTemplateBindingsButton	O botão do componente de vinculação de modelo para o WhatsApp
WhatsAppMessageTemplateBindingsComponent	O componente de vinculações de modelo para o WhatsApp
WhatsAppMessageTemplateItemOutput	O contrato de resposta de modelo específico do WhatsApp

Aliases de Tipo

CommunicationMessageKind	Alias para CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias para CommunicationMessagesChannelOutput
GetArrayType	Tipo auxiliar para extrair o tipo de uma matriz
GetMediaParameters
GetPage	O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.
ListTemplatesParameters
MessageTemplateBindings	O objeto de vinculação para vincular valores aos locais específicos do modelo
MessageTemplateBindingsKind	Alias para MessageTemplateBindingsKind
MessageTemplateItemOutput	O modelo de mensagem conforme retornado do serviço.
MessageTemplateStatusOutput	Alias para MessageTemplateStatusOutput
MessageTemplateValue	A classe descreve um parâmetro de um modelo.
MessageTemplateValueKind	Alias para MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Detalhes da mensagem a enviar.
PagedMessageTemplateItemOutput	Coleção paginada de itens MessageTemplateItem
PaginateReturn	Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor padrão é value. Este tipo nos permitirá fornecer Iterator fortemente tipado com base na resposta que obtemos como segundo parâmetro
RepeatabilityResultOutput	Alias para RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias para WhatsAppMessageButtonSubType

Funções

default(string, ClientOptions)	Inicializar uma nova instância do MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Inicializar uma nova instância do MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

Detalhes de Função

default(string, ClientOptions)

Inicializar uma nova instância do MessagesServiceClient

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

Parâmetros

connectionString

string

O connectionString ou url do recurso dos Serviços de Comunicação.

options

ClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inicializar uma nova instância do MessagesServiceClient

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

Parâmetros

endpoint

string

O ponto de extremidade do seu recurso de Serviços de Comunicação.

credential

KeyCredential | TokenCredential

A chave ou credencial de token.

options

ClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parâmetros

response

GetMedia200Response | GetMediaDefaultResponse

Devoluções

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parâmetros

response

Send202Response | SendDefaultResponse

Devoluções

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parâmetros

response

ListTemplates200Response | ListTemplatesDefaultResponse

Devoluções

response

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

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

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

Parâmetros

client

Client

Cliente a utilizar para enviar os pedidos da página seguinte

initialResponse

TResponse

Resposta inicial contendo o nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator para iterar os elementos