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>

public final class ImageNotificationContent extends NotificationContent
A request to send an image notification.
  • Constructor Details

    • ImageNotificationContent

      public ImageNotificationContent(String channelRegistrationId, List<String> to, String mediaUrl)
      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

      public CommunicationMessageKind getKind()
      Get the kind property: The type discriminator describing a notification type.
      Overrides:
      getKind in class NotificationContent
      Returns:
      the kind value.
    • getMediaUrl

      public String 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

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<NotificationContent>
      Overrides:
      toJson in class NotificationContent
      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

      public String getCaption()
      Get the caption property: Optional text content.
      Returns:
      the caption value.
    • setCaption

      public ImageNotificationContent setCaption(String caption)
      Set the caption property: Optional text content.
      Parameters:
      caption - the caption value to set.
      Returns:
      the ImageNotificationContent object itself.