Class ImageNotificationContent
java.lang.Object
com.azure.communication.messages.models.NotificationContent
com.azure.communication.messages.models.ImageNotificationContent
- All Implemented Interfaces:
com.azure.json.JsonSerializable<NotificationContent>
A request to send an image notification.
-
Constructor Summary
ConstructorsConstructorDescriptionImageNotificationContent
(String channelRegistrationId, List<String> to, String mediaUrl) Creates an instance of ImageNotificationContent class. -
Method Summary
Modifier and TypeMethodDescriptionstatic ImageNotificationContent
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of ImageNotificationContent from the JsonReader.Get the caption property: Optional text content.getKind()
Get the kind property: The type discriminator describing a notification type.Get the mediaUrl property: A media url for the file.setCaption
(String caption) Set the caption property: Optional text content.com.azure.json.JsonWriter
toJson
(com.azure.json.JsonWriter jsonWriter) Methods inherited from class com.azure.communication.messages.models.NotificationContent
getChannelRegistrationId, getTo
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
ImageNotificationContent
Creates an instance of ImageNotificationContent class.- Parameters:
channelRegistrationId
- the channelRegistrationId value to set.to
- the to value to set.mediaUrl
- the mediaUrl value to set.
-
-
Method Details
-
getKind
Get the kind property: The type discriminator describing a notification type.- Overrides:
getKind
in classNotificationContent
- Returns:
- the kind value.
-
getMediaUrl
Get the mediaUrl property: A media url for the file. Required if the type is one of the supported media types, e.g. image.- Returns:
- the mediaUrl value.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<NotificationContent>
- Overrides:
toJson
in classNotificationContent
- Throws:
IOException
-
fromJson
public static ImageNotificationContent fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of ImageNotificationContent from the JsonReader.- Parameters:
jsonReader
- The JsonReader being read.- Returns:
- An instance of ImageNotificationContent if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException
- If the deserialized JSON object was missing any required properties.IOException
- If an error occurs while reading the ImageNotificationContent.
-
getCaption
Get the caption property: Optional text content.- Returns:
- the caption value.
-
setCaption
Set the caption property: Optional text content.- Parameters:
caption
- the caption value to set.- Returns:
- the ImageNotificationContent object itself.
-