@azure-rest/communication-messages package

Interfaces

AudioNotificationContent	Solicitud para enviar una notificación de audio.
DocumentNotificationContent	Solicitud para enviar una notificación de documento.
GetMedia
GetMedia200Headers
GetMedia200Response	La solicitud se ha realizado correctamente.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Solicitud para enviar una notificación de imagen.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	La solicitud se ha realizado correctamente.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Recepción del envío de un mensaje.
MessageTemplate	Objeto de plantilla usado para crear plantillas.
MessageTemplateBindingsParent	Objeto de enlace para vincular valores a las ubicaciones específicas de la plantilla
MessageTemplateDocument	Información del valor del documento de la plantilla de mensaje.
MessageTemplateImage	Información de valor de imagen de la plantilla de mensaje.
MessageTemplateItemOutputParent	Plantilla de mensaje tal como se devuelve del servicio.
MessageTemplateLocation	Información del valor de ubicación de la plantilla de mensaje.
MessageTemplateQuickAction	Información de valor de acción rápida de la plantilla de mensaje.
MessageTemplateText	Información del valor de texto de la plantilla de mensaje.
MessageTemplateValueParent	La clase describe un parámetro de una plantilla.
MessageTemplateVideo	Información de valor de vídeo de la plantilla de mensaje.
MessagesServiceClientOptions	Parámetros opcionales para el cliente
NotificationContentParent	Detalles del mensaje que se va a enviar.
PagingOptions	Opciones para el asistente de paginación
Routes
Send
Send202Headers
Send202Response	La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Resultado de la operación de envío de mensajes.
TemplateNotificationContent	Solicitud para enviar una notificación de plantilla.
TextNotificationContent	Una solicitud para enviar una notificación de texto.
VideoNotificationContent	Una solicitud para enviar una notificación de vídeo.
WhatsAppMessageTemplateBindings	Enlaces de plantilla para WhatsApp
WhatsAppMessageTemplateBindingsButton	Botón del componente enlaces de plantilla para WhatsApp
WhatsAppMessageTemplateBindingsComponent	Componente de enlaces de plantilla para WhatsApp
WhatsAppMessageTemplateItemOutput	Contrato de respuesta de plantilla específica de WhatsApp

Alias de tipos

CommunicationMessageKind	Alias para CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias para CommunicationMessagesChannelOutput
GetArrayType	Tipo auxiliar para extraer el tipo de una matriz
GetMediaParameters
GetPage	Tipo de una función personalizada que define cómo obtener una página y un vínculo al siguiente si existe.
ListTemplatesParameters
MessageTemplateBindings	Objeto de enlace para vincular valores a las ubicaciones específicas de la plantilla
MessageTemplateBindingsKind	Alias para MessageTemplateBindingsKind
MessageTemplateItemOutput	Plantilla de mensaje tal como se devuelve del servicio.
MessageTemplateStatusOutput	Alias para MessageTemplateStatusOutput
MessageTemplateValue	La clase describe un parámetro de una plantilla.
MessageTemplateValueKind	Alias para MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Detalles del mensaje que se va a enviar.
PagedMessageTemplateItemOutput	Colección paginada de elementos MessageTemplateItem
PaginateReturn	Tipo auxiliar para deducir el tipo de los elementos paginados del tipo de respuesta Este tipo se genera en función de la información de swagger para x-ms-pageable específicamente en la propiedad itemName, que indica la propiedad de la respuesta donde se encuentran los elementos de página. El valor predeterminado es value. Este tipo nos permitirá proporcionar iterador fuertemente tipado en función de la respuesta que obtenemos como segundo parámetro.
RepeatabilityResultOutput	Alias para RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias para WhatsAppMessageButtonSubType

Funciones

default(string, ClientOptions)	Inicialización de una nueva instancia de MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Inicialización de una nueva instancia de MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de Autorest x-ms-pageable extensión

Detalles de la función

default(string, ClientOptions)

Inicialización de una nueva instancia de MessagesServiceClient

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

Parámetros

connectionString

string

ConnectionString o la dirección URL del recurso de Communication Services.

options

ClientOptions

el parámetro para todos los parámetros opcionales

Devoluciones

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inicialización de una nueva instancia de MessagesServiceClient

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

Parámetros

endpoint

string

Punto de conexión del recurso de Communication Services.

credential

KeyCredential | TokenCredential

Clave o credencial de token.

options

ClientOptions

el parámetro para todos los parámetros opcionales

Devoluciones

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parámetros

response

GetMedia200Response | GetMediaDefaultResponse

Devoluciones

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parámetros

response

Send202Response | SendDefaultResponse

Devoluciones

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parámetros

response

ListTemplates200Response | ListTemplatesDefaultResponse

Devoluciones

response

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

Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de Autorest x-ms-pageable extensión

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

Parámetros

client

Client

Cliente que se va a usar para enviar las solicitudes de página siguiente

initialResponse

TResponse

Respuesta inicial que contiene la página nextLink y actual de los elementos

options

PagingOptions<TResponse>

Devoluciones

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator para iterar los elementos