Package software.amazon.awssdk.services.pinpoint.model

Class SMSMessage

    • Method Detail

      • body

        public final String body()

        The body of the SMS message.

        Returns:
        The body of the SMS message.

      • keyword

        public final String keyword()

        The SMS program name that you provided to AWS Support when you requested your dedicated number.

        Returns:
        The SMS program name that you provided to AWS Support when you requested your dedicated number.

      • mediaUrl

        public final String mediaUrl()

        This field is reserved for future use.

        Returns:
        This field is reserved for future use.

      • messageType

        public final MessageType messageType()

        The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

        If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

        Returns:
        The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
        See Also:
        MessageType

      • messageTypeAsString

        public final String messageTypeAsString()

        The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

        If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

        Returns:
        The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
        See Also:
        MessageType

      • originationNumber

        public final String originationNumber()

        The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

        Returns:
        The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

      • senderId

        public final String senderId()

        The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

        Returns:
        The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

      • hasSubstitutions

        public final boolean hasSubstitutions()
        For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • substitutions

        public final Map<String,​List<String>> substitutions()

        The message variables to use in the SMS message. You can override the default variables with individual address variables.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubstitutions() method.

        Returns:
        The message variables to use in the SMS message. You can override the default variables with individual address variables.

      • entityId

        public final String entityId()

        The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

        Returns:
        The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

      • templateId

        public final String templateId()

        The template ID received from the regulatory body for sending SMS in your country.

        Returns:
        The template ID received from the regulatory body for sending SMS in your country.

      • hashCode

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

      • equals

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

      • 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)