@azure-rest/communication-messages package

Interfaces

AudioNotificationContent	Uma solicitação para enviar uma notificação de áudio.
DocumentNotificationContent	Uma solicitação para enviar uma notificação de documento.
GetMedia
GetMedia200Headers
GetMedia200Response	A solicitação foi bem-sucedida.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Uma solicitação para enviar uma notificação de imagem.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	A solicitação foi bem-sucedida.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Recebimento da mensagem de envio.
MessageTemplate	O objeto de modelo usado para criar modelos.
MessageTemplateBindingsParent	O objeto de associaçã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 de imagem do modelo de mensagem.
MessageTemplateItemOutputParent	O modelo de mensagem conforme retornado do serviço.
MessageTemplateLocation	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	As informações de valor de vídeo do modelo de mensagem.
MessagesServiceClientOptions	Os parâmetros opcionais para o cliente
NotificationContentParent	Detalhes da mensagem a ser enviada.
PagingOptions	Opções para o auxiliar de paginação
Routes
Send
Send202Headers
Send202Response	A solicitação foi aceita 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	Uma solicitação para enviar uma notificação de texto.
VideoNotificationContent	Uma solicitação para enviar uma notificação por vídeo.
WhatsAppMessageTemplateBindings	As associações de modelo para WhatsApp
WhatsAppMessageTemplateBindingsButton	O botão de componente de associações de modelo para WhatsApp
WhatsAppMessageTemplateBindingsComponent	O componente de associações de modelo para 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 associaçã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 ser enviada.
PagedMessageTemplateItemOutput	Coleção de páginas de itens MessageTemplateItem
PaginateReturn	Tipo auxiliar para inferir o tipo dos elementos de página do tipo de resposta Esse tipo é gerado com base nas informações de swagger para x-ms-pageable especificamente na propriedade itemName que indica a propriedade da resposta em que os itens de página são encontrados. O valor padrão é value. Esse tipo nos permitirá fornecer Iterador 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 de MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Inicializar uma nova instância de MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão de x-ms-pageable Autorest

Detalhes da função

default(string, ClientOptions)

Inicializar uma nova instância de MessagesServiceClient

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

Parâmetros

connectionString

string

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

options

ClientOptions

o parâmetro para todos os parâmetros opcionais

Retornos

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inicializar uma nova instância de MessagesServiceClient

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

Parâmetros

endpoint

string

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

credential

KeyCredential | TokenCredential

A chave ou a credencial de token.

options

ClientOptions

o parâmetro para todos os parâmetros opcionais

Retornos

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parâmetros

response

GetMedia200Response | GetMediaDefaultResponse

Retornos

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parâmetros

response

Send202Response | SendDefaultResponse

Retornos

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parâmetros

response

ListTemplates200Response | ListTemplatesDefaultResponse

Retornos

response

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

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

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

Parâmetros

client

Client

Cliente a ser usado para enviar as solicitações da próxima página

initialResponse

TResponse

Resposta inicial que contém o nextLink e a página atual dos elementos

options

PagingOptions<TResponse>

Retornos

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator para iterar os elementos