@azure-rest/communication-messages package

Gränssnitt

AudioNotificationContent	En begäran om att skicka ett ljudmeddelande.
DocumentNotificationContent	En begäran om att skicka ett dokumentmeddelande.
GetMedia
GetMedia200Headers
GetMedia200Response	Begäran har slutförts.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	En begäran om att skicka ett bildmeddelande.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	Begäran har slutförts.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Mottagande av meddelandet som skickas.
MessageTemplate	Mallobjektet som används för att skapa mallar.
MessageTemplateBindingsParent	Bindningsobjektet för att länka värden till mallspecifika platser
MessageTemplateDocument	Meddelandemallens dokumentvärdesinformation.
MessageTemplateImage	Meddelandemallens bildvärdesinformation.
MessageTemplateItemOutputParent	Meddelandemallen som returneras från tjänsten.
MessageTemplateLocation	Meddelandemallens platsvärdesinformation.
MessageTemplateQuickAction	Meddelandemallens snabbåtgärdsvärdeinformation.
MessageTemplateText	Meddelandemallens textvärdesinformation.
MessageTemplateValueParent	Klassen beskriver en parameter för en mall.
MessageTemplateVideo	Information om videovärde i meddelandemallen.
MessagesServiceClientOptions	Valfria parametrar för klienten
NotificationContentParent	Information om meddelandet som ska skickas.
PagingOptions	Alternativ för växlingshjälpen
Routes
Send
Send202Headers
Send202Response	Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Resultatet av åtgärden skicka meddelande.
TemplateNotificationContent	En begäran om att skicka ett mallmeddelande.
TextNotificationContent	En begäran om att skicka ett textmeddelande.
VideoNotificationContent	En begäran om att skicka ett videomeddelande.
WhatsAppMessageTemplateBindings	Mallbindningarna för WhatsApp
WhatsAppMessageTemplateBindingsButton	Komponentknappen för mallbindningar för WhatsApp
WhatsAppMessageTemplateBindingsComponent	Komponenten för mallbindningar för WhatsApp
WhatsAppMessageTemplateItemOutput	Svarskontraktet för WhatsApp-specifik mall

Typalias

CommunicationMessageKind	Alias för CommunicationMessageKind
CommunicationMessagesChannelOutput	Alias för CommunicationMessagesChannelOutput
GetArrayType	Hjälptyp för att extrahera typen av en matris
GetMediaParameters
GetPage	Typen av en anpassad funktion som definierar hur du hämtar en sida och en länk till nästa om någon.
ListTemplatesParameters
MessageTemplateBindings	Bindningsobjektet för att länka värden till mallspecifika platser
MessageTemplateBindingsKind	Alias för MessageTemplateBindingsKind
MessageTemplateItemOutput	Meddelandemallen som returneras från tjänsten.
MessageTemplateStatusOutput	Alias för MessageTemplateStatusOutput
MessageTemplateValue	Klassen beskriver en parameter för en mall.
MessageTemplateValueKind	Alias för MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Information om meddelandet som ska skickas.
PagedMessageTemplateItemOutput	Sidsidig samling av MessageTemplateItem-objekt
PaginateReturn	Hjälptyp för att härleda typen av sidelement från svarstypen Den här typen genereras baserat på swagger-informationen för x-ms-pageable specifikt på egenskapen itemName som anger egenskapen för svaret där sidobjekten hittas. Standardvärdet är value. Med den här typen kan vi ange en starkt typbaserad iterator baserat på svaret vi får som andra parameter
RepeatabilityResultOutput	Alias för RepeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias för WhatsAppMessageButtonSubType

Funktioner

default(string, ClientOptions)	Initiera en ny instans av MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Initiera en ny instans av MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

Funktionsinformation

default(string, ClientOptions)

Initiera en ny instans av MessagesServiceClient

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

Parametrar

connectionString

string

ConnectionString eller URL för din Communication Services-resurs.

options

ClientOptions

parametern för alla valfria parametrar

Returer

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Initiera en ny instans av MessagesServiceClient

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

Parametrar

endpoint

string

Slutpunkten för din Communication Services-resurs.

credential

KeyCredential | TokenCredential

Nyckeln eller tokenautentiseringsuppgifterna.

options

ClientOptions

parametern för alla valfria parametrar

Returer

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parametrar

response

GetMedia200Response | GetMediaDefaultResponse

Returer

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parametrar

response

Send202Response | SendDefaultResponse

Returer

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parametrar

response

ListTemplates200Response | ListTemplatesDefaultResponse

Returer

response

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

Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

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

Parametrar

client

Client

Klienten som ska användas för att skicka nästa sidbegäranden

initialResponse

TResponse

Första svaret som innehåller nästaLänk och aktuell sida med element

options

PagingOptions<TResponse>

Returer

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator för att iterera elementen