@azure-rest/communication-messages package
Interfaces
| AudioNotificationContent |
A request to send an audio notification. |
| DocumentNotificationContent |
A request to send a document notification. |
| GetMedia | |
| GetMedia200Headers | |
| GetMedia200Response |
The request has succeeded. |
| GetMediaDefaultHeaders | |
| GetMediaDefaultResponse | |
| GetMediaHeaderParam | |
| GetMediaHeaders | |
| ImageNotificationContent |
A request to send an image notification. |
| ListTemplates | |
| ListTemplates200Headers | |
| ListTemplates200Response |
The request has succeeded. |
| ListTemplatesDefaultHeaders | |
| ListTemplatesDefaultResponse | |
| ListTemplatesHeaderParam | |
| ListTemplatesHeaders | |
| ListTemplatesQueryParam | |
| ListTemplatesQueryParamProperties | |
| MediaNotificationContent | |
| MessageReceiptOutput |
Receipt of the sending one message. |
| MessageTemplate |
The template object used to create templates. |
| MessageTemplateBindingsParent |
The binding object to link values to the template specific locations |
| MessageTemplateDocument |
The message template's document value information. |
| MessageTemplateImage |
The message template's image value information. |
| MessageTemplateItemOutputParent |
The message template as returned from the service. |
| MessageTemplateLocation |
The message template's location value information. |
| MessageTemplateQuickAction |
The message template's quick action value information. |
| MessageTemplateText |
The message template's text value information. |
| MessageTemplateValueParent |
The class describes a parameter of a template. |
| MessageTemplateVideo |
The message template's video value information. |
| MessagesServiceClientOptions |
The optional parameters for the client |
| NotificationContentParent |
Details of the message to send. |
| PagingOptions |
Options for the paging helper |
| Routes | |
| Send | |
| Send202Headers | |
| Send202Response |
The request has been accepted for processing, but processing has not yet completed. |
| SendBodyParam | |
| SendDefaultHeaders | |
| SendDefaultResponse | |
| SendHeaderParam | |
| SendHeaders | |
| SendMessageResultOutput |
Result of the send message operation. |
| TemplateNotificationContent |
A request to send a template notification. |
| TextNotificationContent |
A request to send a text notification. |
| VideoNotificationContent |
A request to send a video notification. |
| WhatsAppMessageTemplateBindings |
The template bindings for WhatsApp |
| WhatsAppMessageTemplateBindingsButton |
The template bindings component button for WhatsApp |
| WhatsAppMessageTemplateBindingsComponent |
The template bindings component for WhatsApp |
| WhatsAppMessageTemplateItemOutput |
The WhatsApp-specific template response contract |
Type Aliases
| CommunicationMessageKind |
Alias for CommunicationMessageKind |
| CommunicationMessagesChannelOutput |
Alias for CommunicationMessagesChannelOutput |
| GetArrayType |
Helper type to extract the type of an array |
| GetMediaParameters | |
| GetPage |
The type of a custom function that defines how to get a page and a link to the next one if any. |
| ListTemplatesParameters | |
| MessageTemplateBindings |
The binding object to link values to the template specific locations |
| MessageTemplateBindingsKind |
Alias for MessageTemplateBindingsKind |
| MessageTemplateItemOutput |
The message template as returned from the service. |
| MessageTemplateStatusOutput |
Alias for MessageTemplateStatusOutput |
| MessageTemplateValue |
The class describes a parameter of a template. |
| MessageTemplateValueKind |
Alias for MessageTemplateValueKind |
| MessagesServiceClient | |
| NotificationContent |
Details of the message to send. |
| PagedMessageTemplateItemOutput |
Paged collection of MessageTemplateItem items |
| PaginateReturn |
Helper type to infer the Type of the paged elements from the response type
This type is generated based on the swagger information for x-ms-pageable
specifically on the itemName property which indicates the property of the response
where the page items are found. The default value is |
| RepeatabilityResultOutput |
Alias for RepeatabilityResultOutput |
| SendParameters | |
| WhatsAppMessageButtonSubType |
Alias for WhatsAppMessageButtonSubType |
Functions
| default(string, Client |
Initialize a new instance of |
| default(string, Key |
Initialize a new instance of |
| is |
|
| is |
|
| is |
|
| paginate<TResponse>(Client, TResponse, Paging |
Helper to paginate results from an initial response that follows the specification of Autorest |
Function Details
default(string, ClientOptions)
Initialize a new instance of MessagesServiceClient
function default(connectionString: string, options?: ClientOptions): MessagesServiceClientParameters
- connectionString
-
string
The connectionString or url of your Communication Services resource.
- options
- ClientOptions
the parameter for all optional parameters
Returns
default(string, KeyCredential | TokenCredential, ClientOptions)
Initialize a new instance of MessagesServiceClient
function default(endpoint: string, credential: KeyCredential | TokenCredential, options?: ClientOptions): MessagesServiceClientParameters
- endpoint
-
string
The endpoint of your Communication Services resource.
- credential
The key or token credential.
- options
- ClientOptions
the parameter for all optional parameters
Returns
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): responseParameters
- response
Returns
response
isUnexpected(Send202Response | SendDefaultResponse)
function isUnexpected(response: Send202Response | SendDefaultResponse): responseParameters
- response
Returns
response
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): responseParameters
Returns
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>Parameters
- client
- Client
Client to use for sending the next page requests
- initialResponse
-
TResponse
Initial response containing the nextLink and current page of elements
- options
-
PagingOptions<TResponse>
Returns
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator to iterate the elements