Interface MessageRequest.Builder

    • Method Detail

      • addresses

        MessageRequest.Builder addresses​(Map<String,​AddressConfiguration> addresses)

        A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

        Parameters:
        addresses - A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • context

        MessageRequest.Builder context​(Map<String,​String> context)

        A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

        Parameters:
        context - A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • messageConfiguration

        MessageRequest.Builder messageConfiguration​(DirectMessageConfiguration messageConfiguration)

        The settings and content for the default message and any default messages that you defined for specific channels.

        Parameters:
        messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • templateConfiguration

        MessageRequest.Builder templateConfiguration​(TemplateConfiguration templateConfiguration)

        The message template to use for the message.

        Parameters:
        templateConfiguration - The message template to use for the message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traceId

        MessageRequest.Builder traceId​(String traceId)

        The unique identifier for tracing the message. This identifier is visible to message recipients.

        Parameters:
        traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.
        Returns:
        Returns a reference to this object so that method calls can be chained together.