Interface ChannelMessage.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ChannelMessage.Builder,ChannelMessage>, SdkBuilder<ChannelMessage.Builder,ChannelMessage>, SdkPojo
Enclosing class:
ChannelMessage

public static interface ChannelMessage.Builder extends SdkPojo, CopyableBuilder<ChannelMessage.Builder,ChannelMessage>
  • Method Details

    • channelArn

      ChannelMessage.Builder channelArn(String channelArn)

      The ARN of the channel.

      Parameters:
      channelArn - The ARN of the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messageId

      ChannelMessage.Builder messageId(String messageId)

      The ID of a message.

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

      ChannelMessage.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

      ChannelMessage.Builder metadata(String metadata)

      The message metadata.

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

      The message type.

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

      The message type.

      Parameters:
      type - The message type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdTimestamp

      ChannelMessage.Builder createdTimestamp(Instant createdTimestamp)

      The time at which the message was created.

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

      ChannelMessage.Builder lastEditedTimestamp(Instant lastEditedTimestamp)

      The time at which a message was edited.

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

      ChannelMessage.Builder lastUpdatedTimestamp(Instant lastUpdatedTimestamp)

      The time at which a message was updated.

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

      The message sender.

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

      The message sender.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sender(Identity).

      Parameters:
      sender - a consumer that will call methods on Identity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • redacted

      ChannelMessage.Builder redacted(Boolean redacted)

      Hides the content of a message.

      Parameters:
      redacted - Hides the content of a message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • persistence

      ChannelMessage.Builder persistence(String persistence)

      The persistence setting for a channel message.

      Parameters:
      persistence - The persistence setting for a channel message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • persistence

      The persistence setting for a channel message.

      Parameters:
      persistence - The persistence setting for a channel message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the channel message.

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

      The status of the channel message.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(ChannelMessageStatusStructure).

      Parameters:
      status - a consumer that will call methods on ChannelMessageStatusStructure.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • messageAttributes

      ChannelMessage.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.
    • subChannelId

      ChannelMessage.Builder subChannelId(String subChannelId)

      The ID of the SubChannel.

      Parameters:
      subChannelId - The ID of the SubChannel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • contentType

      ChannelMessage.Builder contentType(String contentType)

      The content type of the channel message. 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. 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

      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

      ChannelMessage.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

      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<Target>).

      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: