@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	用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 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

包含 nextLink 和元素当前页的初始响应

options

PagingOptions<TResponse>

返回

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator 循环访问元素