@azure-rest/communication-messages package

介面

AudioNotificationContent	傳送音訊通知的要求。
DocumentNotificationContent	傳送檔通知的要求。
GetMedia
GetMedia200Headers
GetMedia200Response	要求已成功。
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	傳送影像通知的要求。
ListTemplates
ListTemplates200Headers
ListTemplates200Response	要求已成功。
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	收到傳送的一則訊息。
MessageTemplate	用來建立範本的樣板物件。
MessageTemplateBindingsParent	將值連結至範本特定位置的系結物件
MessageTemplateDocument	訊息範本的文件值資訊。
MessageTemplateImage	訊息範本的影像值資訊。
MessageTemplateItemOutputParent	從服務傳回的訊息範本。
MessageTemplateLocation	訊息範本的位置值資訊。
MessageTemplateQuickAction	訊息範本的快速動作值資訊。
MessageTemplateText	訊息範本的文字值資訊。
MessageTemplateValueParent	類別描述範本的參數。
MessageTemplateVideo	訊息範本的影片值資訊。
MessagesServiceClientOptions	用戶端的選擇性參數
NotificationContentParent	要傳送之訊息的詳細數據。
PagingOptions	分頁協助程序的選項
Routes
Send
Send202Headers
Send202Response	要求已接受進行處理，但尚未完成處理。
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	傳送訊息作業的結果。
TemplateNotificationContent	傳送範本通知的要求。
TextNotificationContent	傳送文字通知的要求。
VideoNotificationContent	傳送視訊通知的要求。
WhatsAppMessageTemplateBindings	WhatsApp 的範本系結
WhatsAppMessageTemplateBindingsButton	WhatsApp 的範本系結元件按鈕
WhatsAppMessageTemplateBindingsComponent	WhatsApp 的範本系結元件
WhatsAppMessageTemplateItemOutput	WhatsApp 特定的範本回應合約

類型別名

CommunicationMessageKind	CommunicationMessageKind 的別名
CommunicationMessagesChannelOutput	CommunicationMessagesChannelOutput 的別名
GetArrayType	用來擷取數位型別的協助程序類型
GetMediaParameters
GetPage	自定義函式的類型，定義如何取得頁面，以及下一個頁面的連結，如果有的話。
ListTemplatesParameters
MessageTemplateBindings	將值連結至範本特定位置的系結物件
MessageTemplateBindingsKind	MessageTemplateBindingsKind 的別名
MessageTemplateItemOutput	從服務傳回的訊息範本。
MessageTemplateStatusOutput	MessageTemplateStatusOutput 的別名
MessageTemplateValue	類別描述範本的參數。
MessageTemplateValueKind	MessageTemplateValueKind 的別名
MessagesServiceClient
NotificationContent	要傳送之訊息的詳細數據。
PagedMessageTemplateItemOutput	MessageTemplateItem 專案的分頁集合
PaginateReturn	協助程式類型，從回應類型推斷分頁元素的類型 這個類型是根據 x-ms-pageable 的 Swagger 資訊，特別是 itemName 屬性上的 swagger 資訊，指出找到頁面專案之回應的屬性。 預設值為 value。 此類型可讓我們根據我們取得作為第二個參數的回應，提供強型別反覆運算器
RepeatabilityResultOutput	RepeatabilityResultOutput 的別名
SendParameters
WhatsAppMessageButtonSubType	WhatsAppMessageButtonSubType 的別名

函式

default(string, ClientOptions)	初始化 MessagesServiceClient 的新實例
default(string, KeyCredential | TokenCredential, ClientOptions)	初始化 MessagesServiceClient 的新實例
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	協助程式，從遵循 Autorest x-ms-pageable 擴充功能規格的初始回應分頁結果

函式詳細資料

default(string, ClientOptions)

初始化 MessagesServiceClient 的新實例

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

參數

connectionString

string

通訊服務資源的 connectionString 或 URL。

options

ClientOptions

所有選擇性參數的參數

傳回

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

初始化 MessagesServiceClient 的新實例

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

參數

endpoint

string

通訊服務資源的端點。

credential

KeyCredential | TokenCredential

金鑰或令牌認證。

options

ClientOptions

所有選擇性參數的參數

傳回

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

參數

response

GetMedia200Response | GetMediaDefaultResponse

傳回

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

參數

response

Send202Response | SendDefaultResponse

傳回

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

參數

response

ListTemplates200Response | ListTemplatesDefaultResponse

傳回

response

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

協助程式，從遵循 Autorest x-ms-pageable 擴充功能規格的初始回應分頁結果

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

參數

client

Client

用來傳送下一個頁面要求的用戶端

initialResponse

TResponse

包含專案下一頁和目前頁面的初始回應

options

PagingOptions<TResponse>

傳回

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator 來反覆運算元素