Condividi tramite

@azure-rest/communication-messages package

  • Riferimento

Interfacce

AudioNotificationContent

Richiesta di invio di una notifica audio.
DocumentNotificationContent

Richiesta di invio di una notifica di documento.
GetMedia
GetMedia200Headers
GetMedia200Response

La richiesta ha avuto esito positivo.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent

Richiesta di invio di una notifica di immagine.
ListTemplates
ListTemplates200Headers
ListTemplates200Response

La richiesta ha avuto esito positivo.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput

Ricezione dell'invio di un messaggio.
MessageTemplate

Oggetto modello utilizzato per creare modelli.
MessageTemplateBindingsParent

Oggetto di associazione per collegare i valori alle posizioni specifiche del modello
MessageTemplateDocument

Informazioni sul valore del documento del modello di messaggio.
MessageTemplateImage

Informazioni sul valore dell'immagine del modello di messaggio.
MessageTemplateItemOutputParent

Modello di messaggio restituito dal servizio.
MessageTemplateLocation

Informazioni sul valore della posizione del modello di messaggio.
MessageTemplateQuickAction

Informazioni sul valore dell'azione rapida del modello di messaggio.
MessageTemplateText

Informazioni sul valore di testo del modello di messaggio.
MessageTemplateValueParent

La classe descrive un parametro di un modello.
MessageTemplateVideo

Informazioni sul valore video del modello di messaggio.
MessagesServiceClientOptions

Parametri facoltativi per il client
NotificationContentParent

Dettagli del messaggio da inviare.
PagingOptions

Opzioni per l'helper di paging
Routes
Send
Send202Headers
Send202Response

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput

Risultato dell'operazione di invio del messaggio.
TemplateNotificationContent

Richiesta di invio di una notifica di modello.
TextNotificationContent

Richiesta di invio di una notifica di testo.
VideoNotificationContent

Richiesta di invio di una notifica video.
WhatsAppMessageTemplateBindings

Associazioni di modelli per WhatsApp
WhatsAppMessageTemplateBindingsButton

Pulsante del componente di binding del modello per WhatsApp
WhatsAppMessageTemplateBindingsComponent

Componente di binding del modello per WhatsApp
WhatsAppMessageTemplateItemOutput

Il contratto di risposta del modello specifico di WhatsApp

Alias tipo

CommunicationMessageKind

Alias per CommunicationMessageKind
CommunicationMessagesChannelOutput

Alias per CommunicationMessagesChannelOutput
GetArrayType

Tipo di helper per estrarre il tipo di una matrice
GetMediaParameters
GetPage

Tipo di una funzione personalizzata che definisce come ottenere una pagina e un collegamento a quello successivo, se presente.
ListTemplatesParameters
MessageTemplateBindings

Oggetto di associazione per collegare i valori alle posizioni specifiche del modello
MessageTemplateBindingsKind

Alias per MessageTemplateBindingsKind
MessageTemplateItemOutput

Modello di messaggio restituito dal servizio.
MessageTemplateStatusOutput

Alias per MessageTemplateStatusOutput
MessageTemplateValue

La classe descrive un parametro di un modello.
MessageTemplateValueKind

Alias per MessageTemplateValueKind
MessagesServiceClient
NotificationContent

Dettagli del messaggio da inviare.
PagedMessageTemplateItemOutput

Raccolta di pagine di elementi MessageTemplateItem
PaginateReturn

Tipo di helper per dedurre il tipo di elementi di paging dal tipo di risposta Questo tipo viene generato in base alle informazioni swagger per x-ms-pageable specificamente nella proprietà itemName che indica la proprietà della risposta in cui vengono trovati gli elementi della pagina. Il valore predefinito è value. Questo tipo consentirà di fornire iteratore fortemente tipizzato in base alla risposta che si ottiene come secondo parametro
RepeatabilityResultOutput

Alias per RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType

Alias per WhatsAppMessageButtonSubType

Funzioni

default(string, ClientOptions)

Inizializzare una nuova istanza di MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)

Inizializzare una nuova istanza di MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper per impaginare i risultati da una risposta iniziale che segue la specifica dell'estensione autorest x-ms-pageable

Dettagli funzione

default(string, ClientOptions)

Inizializzare una nuova istanza di MessagesServiceClient

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

Parametri

connectionString

string

ConnectionString o URL della risorsa di Servizi di comunicazione.

options
ClientOptions

parametro per tutti i parametri facoltativi

Restituisce

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inizializzare una nuova istanza di MessagesServiceClient

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

Parametri

endpoint

string

Endpoint della risorsa di Servizi di comunicazione.

credential

KeyCredential | TokenCredential

Credenziale della chiave o del token.

options
ClientOptions

parametro per tutti i parametri facoltativi

Restituisce

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse) 

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parametri

response

GetMedia200Response | GetMediaDefaultResponse

Restituisce

response

isUnexpected(Send202Response | SendDefaultResponse) 

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parametri

response

Send202Response | SendDefaultResponse

Restituisce

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse) 

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parametri

response

ListTemplates200Response | ListTemplatesDefaultResponse

Restituisce

response

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

Helper per impaginare i risultati da una risposta iniziale che segue la specifica dell'estensione autorest x-ms-pageable

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

Parametri

client
Client

Client da usare per l'invio delle richieste di pagina successiva

initialResponse

TResponse

Risposta iniziale contenente il nextLink e la pagina corrente degli elementi

options

PagingOptions<TResponse>

Restituisce

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator per scorrere gli elementi