Interface ChannelMessageSummary.Builder

    • Method Detail

      • messageId

        ChannelMessageSummary.Builder messageId​(String messageId)

        The ID of the message.

        Parameters:
        messageId - The ID of the message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • content

        ChannelMessageSummary.Builder content​(String content)

        The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

        Parameters:
        content - The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • metadata

        ChannelMessageSummary.Builder metadata​(String metadata)

        The metadata of the message.

        Parameters:
        metadata - The metadata of the message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdTimestamp

        ChannelMessageSummary.Builder createdTimestamp​(Instant createdTimestamp)

        The time at which the message summary was created.

        Parameters:
        createdTimestamp - The time at which the message summary was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastUpdatedTimestamp

        ChannelMessageSummary.Builder lastUpdatedTimestamp​(Instant lastUpdatedTimestamp)

        The time at which a message was last updated.

        Parameters:
        lastUpdatedTimestamp - The time at which a message was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastEditedTimestamp

        ChannelMessageSummary.Builder lastEditedTimestamp​(Instant lastEditedTimestamp)

        The time at which a message was last edited.

        Parameters:
        lastEditedTimestamp - The time at which a message was last edited.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sender

        ChannelMessageSummary.Builder sender​(Identity sender)

        The message sender.

        Parameters:
        sender - The message sender.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • redacted

        ChannelMessageSummary.Builder redacted​(Boolean redacted)

        Indicates whether a message was redacted.

        Parameters:
        redacted - Indicates whether a message was redacted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        ChannelMessageSummary.Builder status​(ChannelMessageStatusStructure status)

        The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.

        Parameters:
        status - The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • messageAttributes

        ChannelMessageSummary.Builder messageAttributes​(Map<String,​MessageAttributeValue> messageAttributes)

        The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

        Parameters:
        messageAttributes - The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • contentType

        ChannelMessageSummary.Builder contentType​(String contentType)

        The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

        Parameters:
        contentType - The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • target

        ChannelMessageSummary.Builder target​(Collection<Target> target)

        The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

        Parameters:
        target - The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • target

        ChannelMessageSummary.Builder target​(Target... target)

        The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

        Parameters:
        target - The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • target

        ChannelMessageSummary.Builder target​(Consumer<Target.Builder>... target)

        The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

        This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #target(List).

        Parameters:
        target - a consumer that will call methods on Target.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #target(java.util.Collection)