@azure-rest/communication-messages package

Interfejsy

AudioNotificationContent	Żądanie wysłania powiadomienia audio.
DocumentNotificationContent	Żądanie wysłania powiadomienia o dokumencie.
GetMedia
GetMedia200Headers
GetMedia200Response	Żądanie zakończyło się pomyślnie.
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	Żądanie wysłania powiadomienia o obrazie.
ListTemplates
ListTemplates200Headers
ListTemplates200Response	Żądanie zakończyło się pomyślnie.
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	Potwierdzenie wysłania jednej wiadomości.
MessageTemplate	Obiekt szablonu używany do tworzenia szablonów.
MessageTemplateBindingsParent	Obiekt powiązania umożliwiający łączenie wartości z lokalizacjami specyficznymi dla szablonu
MessageTemplateDocument	Informacje o wartości dokumentu szablonu wiadomości.
MessageTemplateImage	Informacje o wartości obrazu szablonu wiadomości.
MessageTemplateItemOutputParent	Szablon komunikatu zwrócony z usługi.
MessageTemplateLocation	Informacje o wartości lokalizacji szablonu wiadomości.
MessageTemplateQuickAction	Informacje o wartości szybkiej akcji szablonu wiadomości.
MessageTemplateText	Informacje o wartości tekstowej szablonu wiadomości.
MessageTemplateValueParent	Klasa opisuje parametr szablonu.
MessageTemplateVideo	Informacje o wartości wideo szablonu wiadomości.
MessagesServiceClientOptions	Opcjonalne parametry klienta
NotificationContentParent	Szczegóły wiadomości do wysłania.
PagingOptions	Opcje pomocnika stronicowania
Routes
Send
Send202Headers
Send202Response	Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	Wynik operacji wysyłania komunikatu.
TemplateNotificationContent	Żądanie wysłania powiadomienia o szablonie.
TextNotificationContent	Żądanie wysłania powiadomienia tekstowego.
VideoNotificationContent	Żądanie wysłania powiadomienia wideo.
WhatsAppMessageTemplateBindings	Powiązania szablonu dla WhatsApp
WhatsAppMessageTemplateBindingsButton	Przycisk składnika powiązania szablonu dla WhatsApp
WhatsAppMessageTemplateBindingsComponent	Składnik powiązań szablonu dla WhatsApp
WhatsAppMessageTemplateItemOutput	Kontrakt odpowiedzi na szablon specyficzny dla WhatsApp

Aliasy typu

CommunicationMessageKind	Alias dla communicationMessageKind
CommunicationMessagesChannelOutput	Alias dla CommunicationMessagesChannelOutput
GetArrayType	Typ pomocnika w celu wyodrębnienia typu tablicy
GetMediaParameters
GetPage	Typ funkcji niestandardowej, która definiuje sposób pobierania strony i linku do następnej, jeśli istnieje.
ListTemplatesParameters
MessageTemplateBindings	Obiekt powiązania umożliwiający łączenie wartości z lokalizacjami specyficznymi dla szablonu
MessageTemplateBindingsKind	Alias dla MessageTemplateBindingsKind
MessageTemplateItemOutput	Szablon komunikatu zwrócony z usługi.
MessageTemplateStatusOutput	Alias dla MessageTemplateStatusOutput
MessageTemplateValue	Klasa opisuje parametr szablonu.
MessageTemplateValueKind	Alias dla MessageTemplateValueKind
MessagesServiceClient
NotificationContent	Szczegóły wiadomości do wysłania.
PagedMessageTemplateItemOutput	Stronicowana kolekcja elementów MessageTemplateItem
PaginateReturn	Typ pomocnika, aby wywnioskować typ stronicowanych elementów z typu odpowiedzi Ten typ jest generowany na podstawie informacji o programie Swagger dla elementu x-ms-pageable w szczególności na właściwości itemName, która wskazuje właściwość odpowiedzi, w której znaleziono elementy strony. Wartość domyślna to value. Ten typ umożliwi nam zapewnienie silnie typizowanego iteratora na podstawie odpowiedzi, która otrzymujemy jako drugi parametr
RepeatabilityResultOutput	Alias dla repeatabilityResultOutput
SendParameters
WhatsAppMessageButtonSubType	Alias dla WhatsAppMessageButtonSubType

Funkcje

default(string, ClientOptions)	Inicjowanie nowego wystąpienia MessagesServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)	Inicjowanie nowego wystąpienia MessagesServiceClient
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Pomocnik do stronicowania wyników z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable

Szczegóły funkcji

default(string, ClientOptions)

Inicjowanie nowego wystąpienia MessagesServiceClient

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

Parametry

connectionString

string

ConnectionString lub adres URL zasobu usług komunikacyjnych.

options

ClientOptions

parametr dla wszystkich parametrów opcjonalnych

Zwraca

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Inicjowanie nowego wystąpienia MessagesServiceClient

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

Parametry

endpoint

string

Punkt końcowy zasobu usług komunikacyjnych.

credential

KeyCredential | TokenCredential

Poświadczenie klucza lub tokenu.

options

ClientOptions

parametr dla wszystkich parametrów opcjonalnych

Zwraca

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

Parametry

response

GetMedia200Response | GetMediaDefaultResponse

Zwraca

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

Parametry

response

Send202Response | SendDefaultResponse

Zwraca

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

Parametry

response

ListTemplates200Response | ListTemplatesDefaultResponse

Zwraca

response

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

Pomocnik do stronicowania wyników z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable

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

Parametry

client

Client

Klient do użycia do wysyłania żądań następnej strony

initialResponse

TResponse

Początkowa odpowiedź zawierająca element nextLink i bieżącą stronę elementów

options

PagingOptions<TResponse>

Zwraca

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator w celu iterowania elementów