@azure-rest/communication-messages package

Rozhraní

AudioNotificationContent	Žádost o odeslání zvukového oznámení
DocumentNotificationContent	Žádost o odeslání oznámení o dokumentu
GetMedia
GetMedia200Headers
GetMedia200Response	Požadavek byl úspěšný.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Žádost o odeslání oznámení obrázku
ListTemplates
ListTemplates200Headers
ListTemplates200Response	Požadavek byl úspěšný.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Příjem odesílající jedné zprávy.
MessageTemplate	Objekt šablony použitý k vytvoření šablon.
MessageTemplateBindingsParent	Objekt vazby pro propojení hodnot s konkrétními umístěními šablony
MessageTemplateDocument	Informace o hodnotě dokumentu šablony zprávy.
MessageTemplateImage	Informace o hodnotě obrázku šablony zprávy.
MessageTemplateItemOutputParent	Šablona zprávy vrácená ze služby.
MessageTemplateLocation	Informace o hodnotě umístění šablony zprávy.
MessageTemplateQuickAction	Informace o hodnotě rychlé akce šablony zprávy
MessageTemplateText	Informace o textové hodnotě šablony zprávy.
MessageTemplateValueParent	Třída popisuje parametr šablony.
MessageTemplateVideo	Informace o hodnotě videa šablony zprávy.
MessagesServiceClientOptions	Volitelné parametry klienta
NotificationContentParent	Podrobnosti o zprávě, kterou chcete odeslat.
PagingOptions	Možnosti pomocné rutiny stránkování
Routes
Send
Send202Headers
Send202Response	Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Výsledek operace odeslání zprávy
TemplateNotificationContent	Žádost o odeslání oznámení šablony
TextNotificationContent	Žádost o odeslání textového oznámení
VideoNotificationContent	Žádost o odeslání video oznámení.
WhatsAppMessageTemplateBindings	Vazby šablon pro WhatsApp
WhatsAppMessageTemplateBindingsButton	Tlačítko komponenty vazby šablony pro WhatsApp
WhatsAppMessageTemplateBindingsComponent	Komponenta vazby šablony pro WhatsApp
WhatsAppMessageTemplateItemOutput	Kontrakt odpovědi šablony specifické pro WhatsApp

Aliasy typu

CommunicationMessageKind	Alias pro CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias pro CommunicationMessagesChannelOutput
GetArrayType	Pomocný typ pro extrahování typu pole
GetMediaParameters
GetPage	Typ vlastní funkce, která definuje, jak získat stránku, a odkaz na další, pokud existuje.
ListTemplatesParameters
MessageTemplateBindings	Objekt vazby pro propojení hodnot s konkrétními umístěními šablony
MessageTemplateBindingsKind	Alias pro MessageTemplateBindingsKind
MessageTemplateItemOutput	Šablona zprávy vrácená ze služby.
MessageTemplateStatusOutput	Alias pro MessageTemplateStatusOutput
MessageTemplateValue	Třída popisuje parametr šablony.
MessageTemplateValueKind	Alias pro MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Podrobnosti o zprávě, kterou chcete odeslat.
PagedMessageTemplateItemOutput	Stránkovaná kolekce položek MessageTemplateItem
PaginateReturn	Pomocný typ pro odvození typu stránkovaných prvků z typu odpovědi Tento typ je generován na základě informací swagger pro x-ms-pageable konkrétně na itemName vlastnost, která označuje vlastnost odpovědi, kde jsou nalezeny položky stránky. Výchozí hodnota je value. Tento typ nám umožní poskytnout iterátor silného typu na základě odpovědi, která se nám zobrazí jako druhý parametr.
RepeatabilityResultOutput	Alias pro RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias pro WhatsAppMessageButtonSubType

Funkce

default(string, ClientOptions)	Inicializace nové instance MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Inicializace nové instance MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

Podrobnosti funkce

default(string, ClientOptions)

Inicializace nové instance MessagesServiceClient

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

Parametry

connectionString

string

Připojovací řetězec nebo adresa URL prostředku komunikační služby.

options

ClientOptions

parametr pro všechny volitelné parametry

Návraty

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inicializace nové instance MessagesServiceClient

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

Parametry

endpoint

string

Koncový bod vašeho prostředku komunikační služby.

credential

KeyCredential | TokenCredential

Přihlašovací údaje klíče nebo tokenu.

options

ClientOptions

parametr pro všechny volitelné parametry

Návraty

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parametry

response

GetMedia200Response | GetMediaDefaultResponse

Návraty

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parametry

response

Send202Response | SendDefaultResponse

Návraty

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parametry

response

ListTemplates200Response | ListTemplatesDefaultResponse

Návraty

response

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

Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

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

Parametry

client

Client

Klient, který se má použít k odesílání žádostí na další stránku

initialResponse

TResponse

Počáteční odpověď obsahující nextLink a aktuální stránku prvků

options

PagingOptions<TResponse>

Návraty

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator pro iteraci prvků