Class RcsSuggestedAction

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.RcsSuggestedAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RcsSuggestedAction.Builder,RcsSuggestedAction>
@Generated("software.amazon.awssdk:codegen") public final class RcsSuggestedAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RcsSuggestedAction.Builder,RcsSuggestedAction>

A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event.

See Also:

  • Method Details

    • reply

      public final RcsReplyAction reply()

      A suggested reply that sends predefined text and postback data when tapped.

      Returns:
      A suggested reply that sends predefined text and postback data when tapped.

    • openUrl

      public final RcsOpenUrlAction openUrl()

      A suggested action that opens a URL in the user's browser or a webview.

      Returns:
      A suggested action that opens a URL in the user's browser or a webview.

    • dialPhone

      public final RcsDialPhoneAction dialPhone()

      A suggested action that initiates a phone call to the specified number.

      Returns:
      A suggested action that initiates a phone call to the specified number.

    • showLocation

      public final RcsShowLocationAction showLocation()

      A suggested action that shows a location on a map.

      Returns:
      A suggested action that shows a location on a map.

    • requestLocation

      public final RcsRequestLocationAction requestLocation()

      A suggested action that requests the user's current location.

      Returns:
      A suggested action that requests the user's current location.

    • createCalendarEvent

      public final RcsCreateCalendarEventAction createCalendarEvent()

      A suggested action that creates a calendar event on the user's device.

      Returns:
      A suggested action that creates a calendar event on the user's device.

    • toBuilder

      public RcsSuggestedAction.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RcsSuggestedAction.Builder,RcsSuggestedAction>
      Returns:
      a builder for type T

    • builder

      public static RcsSuggestedAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RcsSuggestedAction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • fromReply

      public static RcsSuggestedAction fromReply(RcsReplyAction reply)
      Create an instance of this class with reply() initialized to the given value.

      A suggested reply that sends predefined text and postback data when tapped.

      Parameters:
      reply - A suggested reply that sends predefined text and postback data when tapped.

    • fromReply

      public static RcsSuggestedAction fromReply(Consumer<RcsReplyAction.Builder> reply)
      Create an instance of this class with reply() initialized to the given value.

      A suggested reply that sends predefined text and postback data when tapped.

      Parameters:
      reply - A suggested reply that sends predefined text and postback data when tapped.

    • fromOpenUrl

      public static RcsSuggestedAction fromOpenUrl(RcsOpenUrlAction openUrl)
      Create an instance of this class with openUrl() initialized to the given value.

      A suggested action that opens a URL in the user's browser or a webview.

      Parameters:
      openUrl - A suggested action that opens a URL in the user's browser or a webview.

    • fromOpenUrl

      public static RcsSuggestedAction fromOpenUrl(Consumer<RcsOpenUrlAction.Builder> openUrl)
      Create an instance of this class with openUrl() initialized to the given value.

      A suggested action that opens a URL in the user's browser or a webview.

      Parameters:
      openUrl - A suggested action that opens a URL in the user's browser or a webview.

    • fromDialPhone

      public static RcsSuggestedAction fromDialPhone(RcsDialPhoneAction dialPhone)
      Create an instance of this class with dialPhone() initialized to the given value.

      A suggested action that initiates a phone call to the specified number.

      Parameters:
      dialPhone - A suggested action that initiates a phone call to the specified number.

    • fromDialPhone

      public static RcsSuggestedAction fromDialPhone(Consumer<RcsDialPhoneAction.Builder> dialPhone)
      Create an instance of this class with dialPhone() initialized to the given value.

      A suggested action that initiates a phone call to the specified number.

      Parameters:
      dialPhone - A suggested action that initiates a phone call to the specified number.

    • fromShowLocation

      public static RcsSuggestedAction fromShowLocation(RcsShowLocationAction showLocation)
      Create an instance of this class with showLocation() initialized to the given value.

      A suggested action that shows a location on a map.

      Parameters:
      showLocation - A suggested action that shows a location on a map.

    • fromShowLocation

      public static RcsSuggestedAction fromShowLocation(Consumer<RcsShowLocationAction.Builder> showLocation)
      Create an instance of this class with showLocation() initialized to the given value.

      A suggested action that shows a location on a map.

      Parameters:
      showLocation - A suggested action that shows a location on a map.

    • fromRequestLocation

      public static RcsSuggestedAction fromRequestLocation(RcsRequestLocationAction requestLocation)
      Create an instance of this class with requestLocation() initialized to the given value.

      A suggested action that requests the user's current location.

      Parameters:
      requestLocation - A suggested action that requests the user's current location.

    • fromRequestLocation

      public static RcsSuggestedAction fromRequestLocation(Consumer<RcsRequestLocationAction.Builder> requestLocation)
      Create an instance of this class with requestLocation() initialized to the given value.

      A suggested action that requests the user's current location.

      Parameters:
      requestLocation - A suggested action that requests the user's current location.

    • fromCreateCalendarEvent

      public static RcsSuggestedAction fromCreateCalendarEvent(RcsCreateCalendarEventAction createCalendarEvent)
      Create an instance of this class with createCalendarEvent() initialized to the given value.

      A suggested action that creates a calendar event on the user's device.

      Parameters:
      createCalendarEvent - A suggested action that creates a calendar event on the user's device.

    • fromCreateCalendarEvent

      public static RcsSuggestedAction fromCreateCalendarEvent(Consumer<RcsCreateCalendarEventAction.Builder> createCalendarEvent)
      Create an instance of this class with createCalendarEvent() initialized to the given value.

      A suggested action that creates a calendar event on the user's device.

      Parameters:
      createCalendarEvent - A suggested action that creates a calendar event on the user's device.

    • type

      public RcsSuggestedAction.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RcsSuggestedAction.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RcsSuggestedAction.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.