Index
All Classes and Interfaces|All Packages
A
- Adding the package to your product - Search tag in Overview
- Section
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- APPROVED - Static variable in class com.azure.communication.messages.models.MessageTemplateStatus
-
Message template is approved.
- AUDIO - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Audio message type.
- AudioNotificationContent - Class in com.azure.communication.messages.models
-
A request to send an audio notification.
- AudioNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.AudioNotificationContent
-
Creates an instance of AudioNotificationContent class.
- Authentication - Search tag in Overview
- Section
- Azure Messages client library for Java - Search tag in Overview
- Section
B
- buildAsyncClient() - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
Builds an instance of MessageTemplateAsyncClient class.
- buildAsyncClient() - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Builds an instance of NotificationMessagesAsyncClient class.
- buildClient() - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
Builds an instance of MessageTemplateClient class.
- buildClient() - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Builds an instance of NotificationMessagesClient class.
C
- clientOptions(ClientOptions) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- clientOptions(ClientOptions) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- com.azure.communication.messages - package com.azure.communication.messages
-
Package containing the classes for Messages.
- com.azure.communication.messages.models - package com.azure.communication.messages.models
-
Package containing the data models for Messages.
- com.azure.communication.messages.models.channels - package com.azure.communication.messages.models.channels
-
Package containing the data models for Messages.
- CommunicationMessageKind - Class in com.azure.communication.messages.models
-
The type of message.
- CommunicationMessageKind() - Constructor for class com.azure.communication.messages.models.CommunicationMessageKind
-
Deprecated.
- CommunicationMessagesChannel - Class in com.azure.communication.messages.models
-
The type of the communication messages channel.
- CommunicationMessagesChannel() - Constructor for class com.azure.communication.messages.models.CommunicationMessagesChannel
-
Deprecated.Use the
CommunicationMessagesChannel.fromString(String)
factory method. - configuration(Configuration) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- configuration(Configuration) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- connectionString(String) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
Set a connection string for authorization.
- connectionString(String) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Set a connection string for authorization.
- Contributing - Search tag in Overview
- Section
- credential(KeyCredential) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- credential(KeyCredential) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- credential(TokenCredential) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- credential(TokenCredential) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
D
- DOCUMENT - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Document message type.
- DOCUMENT - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The document template parameter type.
- Documentation - Search tag in Overview
- Section
- DocumentNotificationContent - Class in com.azure.communication.messages.models
-
A request to send a document notification.
- DocumentNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.DocumentNotificationContent
-
Creates an instance of DocumentNotificationContent class.
- downloadMedia(String) - Method in class com.azure.communication.messages.NotificationMessagesAsyncClient
-
Download the Media payload from a User to Business message.
- downloadMedia(String) - Method in class com.azure.communication.messages.NotificationMessagesClient
-
Download the Media payload from a User to Business message.
- downloadMediaWithResponse(String, RequestOptions) - Method in class com.azure.communication.messages.NotificationMessagesAsyncClient
-
Download the Media payload from a User to Business message.
- downloadMediaWithResponse(String, RequestOptions) - Method in class com.azure.communication.messages.NotificationMessagesClient
-
Download the Media payload from a User to Business message.
E
- endpoint(String) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- endpoint(String) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- Examples - Search tag in Overview
- Section
F
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.AudioNotificationContent
-
Reads an instance of AudioNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Reads an instance of WhatsAppMessageTemplateBindings from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsButton
-
Reads an instance of WhatsAppMessageTemplateBindingsButton from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsComponent
-
Reads an instance of WhatsAppMessageTemplateBindingsComponent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateItem
-
Reads an instance of WhatsAppMessageTemplateItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Reads an instance of DocumentNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.ImageNotificationContent
-
Reads an instance of ImageNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Reads an instance of MediaNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageReceipt
-
Reads an instance of MessageReceipt from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplate
-
Reads an instance of MessageTemplate from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateBindings
-
Reads an instance of MessageTemplateBindings from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Reads an instance of MessageTemplateDocument from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateImage
-
Reads an instance of MessageTemplateImage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateItem
-
Reads an instance of MessageTemplateItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Reads an instance of MessageTemplateLocation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Reads an instance of MessageTemplateQuickAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateText
-
Reads an instance of MessageTemplateText from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateValue
-
Reads an instance of MessageTemplateValue from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Reads an instance of MessageTemplateVideo from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.NotificationContent
-
Reads an instance of NotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.SendMessageResult
-
Reads an instance of SendMessageResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.TemplateNotificationContent
-
Reads an instance of TemplateNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.TextNotificationContent
-
Reads an instance of TextNotificationContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.communication.messages.models.VideoNotificationContent
-
Reads an instance of VideoNotificationContent from the JsonReader.
- fromString(String) - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageButtonSubType
-
Creates or finds a WhatsAppMessageButtonSubType from its string representation.
- fromString(String) - Static method in class com.azure.communication.messages.models.CommunicationMessageKind
-
Creates or finds a CommunicationMessageKind from its string representation.
- fromString(String) - Static method in class com.azure.communication.messages.models.CommunicationMessagesChannel
-
Creates or finds a CommunicationMessagesChannel from its string representation.
- fromString(String) - Static method in class com.azure.communication.messages.models.MessageTemplateBindingsKind
-
Creates or finds a MessageTemplateBindingsKind from its string representation.
- fromString(String) - Static method in class com.azure.communication.messages.models.MessageTemplateStatus
-
Creates or finds a MessageTemplateStatus from its string representation.
- fromString(String) - Static method in class com.azure.communication.messages.models.MessageTemplateValueKind
-
Creates or finds a MessageTemplateValueKind from its string representation.
G
- getAddress() - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Get the address property: The [Optional] address of the location.
- getBindings() - Method in class com.azure.communication.messages.models.MessageTemplate
-
Get the bindings property: The binding object to link values to the template specific locations.
- getBody() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Get the body property: The body template bindings.
- getButtons() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Get the buttons property: The button template bindings.
- getCaption() - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Get the caption property: Optional text content.
- getCaption() - Method in class com.azure.communication.messages.models.ImageNotificationContent
-
Get the caption property: Optional text content.
- getCaption() - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Get the caption property: The [optional] caption of the media object.
- getCaption() - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Get the caption property: The [optional] caption of the media object.
- getCaption() - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Get the caption property: The [optional] caption of the media object.
- getCaption() - Method in class com.azure.communication.messages.models.VideoNotificationContent
-
Get the caption property: Optional text content.
- getChannelRegistrationId() - Method in class com.azure.communication.messages.models.NotificationContent
-
Get the channelRegistrationId property: The Channel Registration ID for the Business Identifier.
- getContent() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateItem
-
Get the content property: WhatsApp platform's template content.
- getContent() - Method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Get the content property: Optional text content.
- getContent() - Method in class com.azure.communication.messages.models.TextNotificationContent
-
Get the content property: Message content.
- getFileName() - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Get the fileName property: Optional name for the file.
- getFileName() - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Get the fileName property: The [optional] filename of the media file.
- getFileName() - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Get the fileName property: The [optional] filename of the media file.
- getFileName() - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Get the fileName property: The [optional] filename of the media file.
- getFooter() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Get the footer property: The footer template bindings.
- getHeaderProperty() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Get the headerProperty property: The header template bindings.
- getKind() - Method in class com.azure.communication.messages.models.AudioNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Get the kind property: The type discriminator describing a template bindings type.
- getKind() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateItem
-
Get the kind property: The type discriminator describing a template type.
- getKind() - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.ImageNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateBindings
-
Get the kind property: The type discriminator describing a template bindings type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateItem
-
Get the kind property: The type discriminator describing a template type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateText
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateValue
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Get the kind property: The type discriminator describing a template parameter type.
- getKind() - Method in class com.azure.communication.messages.models.NotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.TemplateNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.TextNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getKind() - Method in class com.azure.communication.messages.models.VideoNotificationContent
-
Get the kind property: The type discriminator describing a notification type.
- getLanguage() - Method in class com.azure.communication.messages.models.MessageTemplate
-
Get the language property: The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'.
- getLanguage() - Method in class com.azure.communication.messages.models.MessageTemplateItem
-
Get the language property: The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'.
- getLatest() - Static method in enum com.azure.communication.messages.MessagesServiceVersion
-
Gets the latest service version supported by this client library.
- getLocationName() - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Get the locationName property: The [Optional] name of the location.
- getMediaUrl() - Method in class com.azure.communication.messages.models.AudioNotificationContent
-
Get the mediaUrl property: A media url for the file.
- getMediaUrl() - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Get the mediaUrl property: A media url for the file.
- getMediaUrl() - Method in class com.azure.communication.messages.models.ImageNotificationContent
-
Get the mediaUrl property: A media url for the file.
- getMediaUrl() - Method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Get the mediaUrl property: A media url for the file.
- getMediaUrl() - Method in class com.azure.communication.messages.models.VideoNotificationContent
-
Get the mediaUrl property: A media url for the file.
- getMessageId() - Method in class com.azure.communication.messages.models.MessageReceipt
-
Get the messageId property: The message id.
- getName() - Method in class com.azure.communication.messages.models.MessageTemplate
-
Get the name property: Name of the template.
- getName() - Method in class com.azure.communication.messages.models.MessageTemplateItem
-
Get the name property: The template's name.
- getPayload() - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Get the payload property: The [Optional] quick action payload.
- getPosition() - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Get the geo position: The longitude and latitude of the location.
- getReceipts() - Method in class com.azure.communication.messages.models.SendMessageResult
-
Get the receipts property: Receipts of the send message operation.
- getRefValue() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsButton
-
Get the refValue property: The name of the referenced item in the template values.
- getRefValue() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsComponent
-
Get the refValue property: The name of the referenced item in the template values.
- getRefValue() - Method in class com.azure.communication.messages.models.MessageTemplateValue
-
Get the refValue property: Template binding reference name.
- getStatus() - Method in class com.azure.communication.messages.models.MessageTemplateItem
-
Get the status property: The aggregated template status.
- getSubType() - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsButton
-
Get the subType property: The WhatsApp button sub type.
- getTemplate() - Method in class com.azure.communication.messages.models.TemplateNotificationContent
-
Get the template property: The template object used to create templates.
- Get Template List for given channel example: - Search tag in Overview
- Section
- getText() - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Get the text property: The [Optional] quick action text.
- getText() - Method in class com.azure.communication.messages.models.MessageTemplateText
-
Get the text property: The text value.
- Getting started - Search tag in Overview
- Section
- getTo() - Method in class com.azure.communication.messages.models.MessageReceipt
-
Get the to property: The native external platform user identifier of the recipient.
- getTo() - Method in class com.azure.communication.messages.models.NotificationContent
-
Get the to property: The native external platform user identifiers of the recipient.
- getUrl() - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Get the url property: The (public) URL of the media.
- getUrl() - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Get the url property: The (public) URL of the media.
- getUrl() - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Get the url property: The (public) URL of the media.
- getValues() - Method in class com.azure.communication.messages.models.MessageTemplate
-
Get the values property: The template values.
- getVersion() - Method in enum com.azure.communication.messages.MessagesServiceVersion
H
- httpClient(HttpClient) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- httpClient(HttpClient) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
I
- IMAGE - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Image message type.
- IMAGE - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The image template parameter type.
- IMAGE_V0 - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Deprecated.Legacy image type for `MediaNotificationContent` which is being deprecated.
- ImageNotificationContent - Class in com.azure.communication.messages.models
-
A request to send an image notification.
- ImageNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.ImageNotificationContent
-
Creates an instance of ImageNotificationContent class.
- Include direct dependency - Search tag in Overview
- Section
K
- Key concepts - Search tag in Overview
- Section
L
- listTemplates(String) - Method in class com.azure.communication.messages.MessageTemplateAsyncClient
-
List all templates for given Azure Communication Services channel.
- listTemplates(String) - Method in class com.azure.communication.messages.MessageTemplateClient
-
List all templates for given Azure Communication Services channel.
- listTemplates(String, RequestOptions) - Method in class com.azure.communication.messages.MessageTemplateAsyncClient
-
List all templates for given Azure Communication Services channel.
- listTemplates(String, RequestOptions) - Method in class com.azure.communication.messages.MessageTemplateClient
-
List all templates for given Azure Communication Services channel.
- LOCATION - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The location template parameter type.
M
- MediaNotificationContent - Class in com.azure.communication.messages.models
-
Deprecated.A request to send an image notification.
- MediaNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Creates an instance of MediaNotificationContent class.
- MessageReceipt - Class in com.azure.communication.messages.models
-
Receipt of the sending one message.
- MessagesServiceVersion - Enum in com.azure.communication.messages
-
Service version of MessagesClient.
- MessageTemplate - Class in com.azure.communication.messages.models
-
The template object used to create templates.
- MessageTemplate(String, String) - Constructor for class com.azure.communication.messages.models.MessageTemplate
-
Creates an instance of MessageTemplate class.
- MessageTemplateAsyncClient - Class in com.azure.communication.messages
-
Initializes a new instance of the asynchronous MessageTemplateClient type.
- MessageTemplateBindings - Class in com.azure.communication.messages.models
-
The binding object to link values to the template specific locations.
- MessageTemplateBindings() - Constructor for class com.azure.communication.messages.models.MessageTemplateBindings
-
Creates an instance of MessageTemplateBindings class.
- MessageTemplateBindingsKind - Class in com.azure.communication.messages.models
-
The type of the message template.
- MessageTemplateBindingsKind() - Constructor for class com.azure.communication.messages.models.MessageTemplateBindingsKind
-
Deprecated.Use the
MessageTemplateBindingsKind.fromString(String)
factory method. - MessageTemplateClient - Class in com.azure.communication.messages
-
Initializes a new instance of the synchronous MessageTemplateClient type.
- MessageTemplateClientBuilder - Class in com.azure.communication.messages
-
A builder for creating a new instance of the MessageTemplateClient type.
- MessageTemplateClientBuilder() - Constructor for class com.azure.communication.messages.MessageTemplateClientBuilder
-
Create an instance of the MessageTemplateClientBuilder.
- MessageTemplateDocument - Class in com.azure.communication.messages.models
-
The message template's document value information.
- MessageTemplateDocument(String, String) - Constructor for class com.azure.communication.messages.models.MessageTemplateDocument
-
Creates an instance of MessageTemplateDocument class.
- MessageTemplateImage - Class in com.azure.communication.messages.models
-
The message template's image value information.
- MessageTemplateImage(String, String) - Constructor for class com.azure.communication.messages.models.MessageTemplateImage
-
Creates an instance of MessageTemplateImage class.
- MessageTemplateItem - Class in com.azure.communication.messages.models
-
The message template as returned from the service.
- MessageTemplateItem(String, MessageTemplateStatus) - Constructor for class com.azure.communication.messages.models.MessageTemplateItem
-
Creates an instance of MessageTemplateItem class.
- MessageTemplateLocation - Class in com.azure.communication.messages.models
-
The message template's location value information.
- MessageTemplateLocation(String, GeoPosition) - Constructor for class com.azure.communication.messages.models.MessageTemplateLocation
-
Creates an instance of MessageTemplateLocation class.
- MessageTemplateQuickAction - Class in com.azure.communication.messages.models
-
The message template's quick action value information.
- MessageTemplateQuickAction(String) - Constructor for class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Creates an instance of MessageTemplateQuickAction class.
- MessageTemplateStatus - Class in com.azure.communication.messages.models
-
The aggregated template status.
- MessageTemplateStatus() - Constructor for class com.azure.communication.messages.models.MessageTemplateStatus
-
Deprecated.Use the
MessageTemplateStatus.fromString(String)
factory method. - MessageTemplateText - Class in com.azure.communication.messages.models
-
The message template's text value information.
- MessageTemplateText(String, String) - Constructor for class com.azure.communication.messages.models.MessageTemplateText
-
Creates an instance of MessageTemplateText class.
- MessageTemplateValue - Class in com.azure.communication.messages.models
-
The class describes a parameter of a template.
- MessageTemplateValue(String) - Constructor for class com.azure.communication.messages.models.MessageTemplateValue
-
Creates an instance of MessageTemplateValue class.
- MessageTemplateValueKind - Class in com.azure.communication.messages.models
-
The type of the template parameter.
- MessageTemplateValueKind() - Constructor for class com.azure.communication.messages.models.MessageTemplateValueKind
-
Deprecated.Use the
MessageTemplateValueKind.fromString(String)
factory method. - MessageTemplateVideo - Class in com.azure.communication.messages.models
-
The message template's video value information.
- MessageTemplateVideo(String, String) - Constructor for class com.azure.communication.messages.models.MessageTemplateVideo
-
Creates an instance of MessageTemplateVideo class.
N
- Next steps - Search tag in Overview
- Section
- NotificationContent - Class in com.azure.communication.messages.models
-
Details of the message to send.
- NotificationContent(String, List<String>) - Constructor for class com.azure.communication.messages.models.NotificationContent
-
Creates an instance of NotificationContent class.
- NotificationMessagesAsyncClient - Class in com.azure.communication.messages
-
Initializes a new instance of the asynchronous NotificationMessagesClient type.
- NotificationMessagesClient - Class in com.azure.communication.messages
-
Initializes a new instance of the synchronous NotificationMessagesClient type.
- NotificationMessagesClientBuilder - Class in com.azure.communication.messages
-
A builder for creating a new instance of the NotificationMessagesClient type.
- NotificationMessagesClientBuilder() - Constructor for class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Create an instance of the NotificationMessagesClientBuilder.
P
- PAUSED - Static variable in class com.azure.communication.messages.models.MessageTemplateStatus
-
Message template is paused.
- PENDING - Static variable in class com.azure.communication.messages.models.MessageTemplateStatus
-
Message template is pending.
- pipeline(HttpPipeline) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- pipeline(HttpPipeline) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- Prerequisites - Search tag in Overview
- Section
Q
- QUICK_ACTION - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The quick action template parameter type.
- QUICK_REPLY - Static variable in class com.azure.communication.messages.models.channels.WhatsAppMessageButtonSubType
-
The WhatsApp button sub type is quick reply.
R
- REJECTED - Static variable in class com.azure.communication.messages.models.MessageTemplateStatus
-
Message template is rejected.
- retryOptions(RetryOptions) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
.
- retryOptions(RetryOptions) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
.
- retryPolicy(RetryPolicy) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- retryPolicy(RetryPolicy) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
S
- send(NotificationContent) - Method in class com.azure.communication.messages.NotificationMessagesAsyncClient
-
Sends a notification message from Business to User.
- send(NotificationContent) - Method in class com.azure.communication.messages.NotificationMessagesClient
-
Sends a notification message from Business to User.
- SendMessageResult - Class in com.azure.communication.messages.models
-
Result of the send message operation.
- sendWithResponse(BinaryData, RequestOptions) - Method in class com.azure.communication.messages.NotificationMessagesAsyncClient
-
Sends a notification message from Business to User.
- sendWithResponse(BinaryData, RequestOptions) - Method in class com.azure.communication.messages.NotificationMessagesClient
-
Sends a notification message from Business to User.
- serviceVersion(MessagesServiceVersion) - Method in class com.azure.communication.messages.MessageTemplateClientBuilder
-
Sets Service version.
- serviceVersion(MessagesServiceVersion) - Method in class com.azure.communication.messages.NotificationMessagesClientBuilder
-
Sets Service version.
- setAddress(String) - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Set the address property: The [Optional] address of the location.
- setBindings(MessageTemplateBindings) - Method in class com.azure.communication.messages.models.MessageTemplate
-
Set the bindings property: The binding object to link values to the template specific locations.
- setBody(List<WhatsAppMessageTemplateBindingsComponent>) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Set the body property: The body template bindings.
- setButtons(List<WhatsAppMessageTemplateBindingsButton>) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Set the buttons property: The button template bindings.
- setCaption(String) - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Set the caption property: Optional text content.
- setCaption(String) - Method in class com.azure.communication.messages.models.ImageNotificationContent
-
Set the caption property: Optional text content.
- setCaption(String) - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Set the caption property: The [optional] caption of the media object.
- setCaption(String) - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Set the caption property: The [optional] caption of the media object.
- setCaption(String) - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Set the caption property: The [optional] caption of the media object.
- setCaption(String) - Method in class com.azure.communication.messages.models.VideoNotificationContent
-
Set the caption property: Optional text content.
- setContent(String) - Method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.Set the content property: Optional text content.
- setFileName(String) - Method in class com.azure.communication.messages.models.DocumentNotificationContent
-
Set the fileName property: Optional name for the file.
- setFileName(String) - Method in class com.azure.communication.messages.models.MessageTemplateDocument
-
Set the fileName property: The [optional] filename of the media file.
- setFileName(String) - Method in class com.azure.communication.messages.models.MessageTemplateImage
-
Set the fileName property: The [optional] filename of the media file.
- setFileName(String) - Method in class com.azure.communication.messages.models.MessageTemplateVideo
-
Set the fileName property: The [optional] filename of the media file.
- setFooter(List<WhatsAppMessageTemplateBindingsComponent>) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Set the footer property: The footer template bindings.
- setHeaderProperty(List<WhatsAppMessageTemplateBindingsComponent>) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Set the headerProperty property: The header template bindings.
- setLocationName(String) - Method in class com.azure.communication.messages.models.MessageTemplateLocation
-
Set the locationName property: The [Optional] name of the location.
- setPayload(String) - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Set the payload property: The [Optional] quick action payload.
- setText(String) - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
-
Set the text property: The [Optional] quick action text.
- setValues(List<MessageTemplateValue>) - Method in class com.azure.communication.messages.models.MessageTemplate
-
Set the values property: The template values.
T
- TEMPLATE - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Template message type.
- TemplateNotificationContent - Class in com.azure.communication.messages.models
-
A request to send a template notification.
- TemplateNotificationContent(String, List<String>, MessageTemplate) - Constructor for class com.azure.communication.messages.models.TemplateNotificationContent
-
Creates an instance of TemplateNotificationContent class.
- TEXT - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Text message type.
- TEXT - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The text template parameter type.
- TextNotificationContent - Class in com.azure.communication.messages.models
-
A request to send a text notification.
- TextNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.TextNotificationContent
-
Creates an instance of TextNotificationContent class.
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.AudioNotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsButton
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsComponent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateItem
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.DocumentNotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.ImageNotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MediaNotificationContent
-
Deprecated.
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageReceipt
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplate
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateBindings
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateDocument
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateImage
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateItem
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateLocation
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateQuickAction
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateText
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateValue
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.MessageTemplateVideo
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.NotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.SendMessageResult
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.TemplateNotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.TextNotificationContent
- toJson(JsonWriter) - Method in class com.azure.communication.messages.models.VideoNotificationContent
- Troubleshooting - Search tag in Overview
- Section
U
- URL - Static variable in class com.azure.communication.messages.models.channels.WhatsAppMessageButtonSubType
-
The WhatsApp button sub type is url.
- Using a connection string - Search tag in Overview
- Section
- Using Azure Active Directory managed identity - Search tag in Overview
- Section
- Using AzureKeyCredential - Search tag in Overview
- Section
V
- V2024_02_01 - Enum constant in enum com.azure.communication.messages.MessagesServiceVersion
-
Enum value 2024-02-01.
- V2024_08_30 - Enum constant in enum com.azure.communication.messages.MessagesServiceVersion
-
Enum value 2024-08-30.
- valueOf(String) - Static method in enum com.azure.communication.messages.MessagesServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.communication.messages.MessagesServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.communication.messages.models.channels.WhatsAppMessageButtonSubType
-
Gets known WhatsAppMessageButtonSubType values.
- values() - Static method in class com.azure.communication.messages.models.CommunicationMessageKind
-
Gets known CommunicationMessageKind values.
- values() - Static method in class com.azure.communication.messages.models.CommunicationMessagesChannel
-
Gets known CommunicationMessagesChannel values.
- values() - Static method in class com.azure.communication.messages.models.MessageTemplateBindingsKind
-
Gets known MessageTemplateBindingsKind values.
- values() - Static method in class com.azure.communication.messages.models.MessageTemplateStatus
-
Gets known MessageTemplateStatus values.
- values() - Static method in class com.azure.communication.messages.models.MessageTemplateValueKind
-
Gets known MessageTemplateValueKind values.
- VIDEO - Static variable in class com.azure.communication.messages.models.CommunicationMessageKind
-
Video message type.
- VIDEO - Static variable in class com.azure.communication.messages.models.MessageTemplateValueKind
-
The video template parameter type.
- VideoNotificationContent - Class in com.azure.communication.messages.models
-
A request to send a video notification.
- VideoNotificationContent(String, List<String>, String) - Constructor for class com.azure.communication.messages.models.VideoNotificationContent
-
Creates an instance of VideoNotificationContent class.
W
- WHATS_APP - Static variable in class com.azure.communication.messages.models.CommunicationMessagesChannel
-
The WhatsApp communication messages channel type.
- WHATS_APP - Static variable in class com.azure.communication.messages.models.MessageTemplateBindingsKind
-
The WhatsApp template type.
- WhatsAppMessageButtonSubType - Class in com.azure.communication.messages.models.channels
-
The WhatsApp button sub type.
- WhatsAppMessageButtonSubType() - Constructor for class com.azure.communication.messages.models.channels.WhatsAppMessageButtonSubType
-
Deprecated.Use the
WhatsAppMessageButtonSubType.fromString(String)
factory method. - WhatsAppMessageTemplateBindings - Class in com.azure.communication.messages.models.channels
-
The template bindings for WhatsApp.
- WhatsAppMessageTemplateBindings() - Constructor for class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindings
-
Creates an instance of WhatsAppMessageTemplateBindings class.
- WhatsAppMessageTemplateBindingsButton - Class in com.azure.communication.messages.models.channels
-
The template bindings component button for WhatsApp.
- WhatsAppMessageTemplateBindingsButton(WhatsAppMessageButtonSubType, String) - Constructor for class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsButton
-
Creates an instance of WhatsAppMessageTemplateBindingsButton class.
- WhatsAppMessageTemplateBindingsComponent - Class in com.azure.communication.messages.models.channels
-
The template bindings component for WhatsApp.
- WhatsAppMessageTemplateBindingsComponent(String) - Constructor for class com.azure.communication.messages.models.channels.WhatsAppMessageTemplateBindingsComponent
-
Creates an instance of WhatsAppMessageTemplateBindingsComponent class.
- WhatsAppMessageTemplateItem - Class in com.azure.communication.messages.models.channels
-
The WhatsApp-specific template response contract.
All Classes and Interfaces|All Packages
CommunicationMessageKind.fromString(String)
factory method.