/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.chimesdkmessaging.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* The details of a message in a channel. *
* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ChannelMessage implements Serializable, Cloneable, StructuredPojo { /** ** The ARN of the channel. *
*/ private String channelArn; /** ** The ID of a message. *
*/ private String messageId; /** ** 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. *
*/ private String content; /** ** The message metadata. *
*/ private String metadata; /** ** The message type. *
*/ private String type; /** ** The time at which the message was created. *
*/ private java.util.Date createdTimestamp; /** ** The time at which a message was edited. *
*/ private java.util.Date lastEditedTimestamp; /** ** The time at which a message was updated. *
*/ private java.util.Date lastUpdatedTimestamp; /** ** The message sender. *
*/ private Identity sender; /** ** Hides the content of a message. *
*/ private Boolean redacted; /** ** The persistence setting for a channel message. *
*/ private String persistence; /** ** The status of the channel message. *
*/ private ChannelMessageStatusStructure status; /** ** 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. *
*/ private java.util.Map* The ID of the SubChannel. *
*/ private String subChannelId; /** *
* 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.
*
* 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. *
*/ private java.util.List* The ARN of the channel. *
* * @param channelArn * The ARN of the channel. */ public void setChannelArn(String channelArn) { this.channelArn = channelArn; } /** ** The ARN of the channel. *
* * @return The ARN of the channel. */ public String getChannelArn() { return this.channelArn; } /** ** The ARN of the channel. *
* * @param channelArn * The ARN of the channel. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withChannelArn(String channelArn) { setChannelArn(channelArn); return this; } /** ** The ID of a message. *
* * @param messageId * The ID of a message. */ public void setMessageId(String messageId) { this.messageId = messageId; } /** ** The ID of a message. *
* * @return The ID of a message. */ public String getMessageId() { return this.messageId; } /** ** The ID of a message. *
* * @param messageId * The ID of a message. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withMessageId(String messageId) { setMessageId(messageId); return this; } /** ** 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. *
* * @param 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. */ public void setContent(String content) { this.content = 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. *
* * @return 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. */ public String getContent() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withContent(String content) { setContent(content); return this; } /** ** The message metadata. *
* * @param metadata * The message metadata. */ public void setMetadata(String metadata) { this.metadata = metadata; } /** ** The message metadata. *
* * @return The message metadata. */ public String getMetadata() { return this.metadata; } /** ** The message metadata. *
* * @param metadata * The message metadata. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withMetadata(String metadata) { setMetadata(metadata); return this; } /** ** The message type. *
* * @param type * The message type. * @see ChannelMessageType */ public void setType(String type) { this.type = type; } /** ** The message type. *
* * @return The message type. * @see ChannelMessageType */ public String getType() { return this.type; } /** ** The message type. *
* * @param type * The message type. * @return Returns a reference to this object so that method calls can be chained together. * @see ChannelMessageType */ public ChannelMessage withType(String type) { setType(type); return this; } /** ** The message type. *
* * @param type * The message type. * @return Returns a reference to this object so that method calls can be chained together. * @see ChannelMessageType */ public ChannelMessage withType(ChannelMessageType type) { this.type = type.toString(); return this; } /** ** The time at which the message was created. *
* * @param createdTimestamp * The time at which the message was created. */ public void setCreatedTimestamp(java.util.Date createdTimestamp) { this.createdTimestamp = createdTimestamp; } /** ** The time at which the message was created. *
* * @return The time at which the message was created. */ public java.util.Date getCreatedTimestamp() { return this.createdTimestamp; } /** ** The time at which the message was created. *
* * @param createdTimestamp * The time at which the message was created. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withCreatedTimestamp(java.util.Date createdTimestamp) { setCreatedTimestamp(createdTimestamp); return this; } /** ** The time at which a message was edited. *
* * @param lastEditedTimestamp * The time at which a message was edited. */ public void setLastEditedTimestamp(java.util.Date lastEditedTimestamp) { this.lastEditedTimestamp = lastEditedTimestamp; } /** ** The time at which a message was edited. *
* * @return The time at which a message was edited. */ public java.util.Date getLastEditedTimestamp() { return this.lastEditedTimestamp; } /** ** The time at which a message was edited. *
* * @param lastEditedTimestamp * The time at which a message was edited. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withLastEditedTimestamp(java.util.Date lastEditedTimestamp) { setLastEditedTimestamp(lastEditedTimestamp); return this; } /** ** The time at which a message was updated. *
* * @param lastUpdatedTimestamp * The time at which a message was updated. */ public void setLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) { this.lastUpdatedTimestamp = lastUpdatedTimestamp; } /** ** The time at which a message was updated. *
* * @return The time at which a message was updated. */ public java.util.Date getLastUpdatedTimestamp() { return this.lastUpdatedTimestamp; } /** ** The time at which a message was updated. *
* * @param lastUpdatedTimestamp * The time at which a message was updated. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) { setLastUpdatedTimestamp(lastUpdatedTimestamp); return this; } /** ** The message sender. *
* * @param sender * The message sender. */ public void setSender(Identity sender) { this.sender = sender; } /** ** The message sender. *
* * @return The message sender. */ public Identity getSender() { return this.sender; } /** ** The message sender. *
* * @param sender * The message sender. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withSender(Identity sender) { setSender(sender); return this; } /** ** Hides the content of a message. *
* * @param redacted * Hides the content of a message. */ public void setRedacted(Boolean redacted) { this.redacted = redacted; } /** ** Hides the content of a message. *
* * @return Hides the content of a message. */ public Boolean getRedacted() { return this.redacted; } /** ** Hides the content of a message. *
* * @param redacted * Hides the content of a message. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withRedacted(Boolean redacted) { setRedacted(redacted); return this; } /** ** Hides the content of a message. *
* * @return Hides the content of a message. */ public Boolean isRedacted() { return this.redacted; } /** ** The persistence setting for a channel message. *
* * @param persistence * The persistence setting for a channel message. * @see ChannelMessagePersistenceType */ public void setPersistence(String persistence) { this.persistence = persistence; } /** ** The persistence setting for a channel message. *
* * @return The persistence setting for a channel message. * @see ChannelMessagePersistenceType */ public String getPersistence() { return this.persistence; } /** ** The persistence setting for a channel message. *
* * @param persistence * The persistence setting for a channel message. * @return Returns a reference to this object so that method calls can be chained together. * @see ChannelMessagePersistenceType */ public ChannelMessage withPersistence(String persistence) { setPersistence(persistence); return this; } /** ** The persistence setting for a channel message. *
* * @param persistence * The persistence setting for a channel message. * @return Returns a reference to this object so that method calls can be chained together. * @see ChannelMessagePersistenceType */ public ChannelMessage withPersistence(ChannelMessagePersistenceType persistence) { this.persistence = persistence.toString(); return this; } /** ** The status of the channel message. *
* * @param status * The status of the channel message. */ public void setStatus(ChannelMessageStatusStructure status) { this.status = status; } /** ** The status of the channel message. *
* * @return The status of the channel message. */ public ChannelMessageStatusStructure getStatus() { return this.status; } /** ** The status of the channel message. *
* * @param status * The status of the channel message. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withStatus(ChannelMessageStatusStructure status) { setStatus(status); return this; } /** ** 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setMessageAttributes(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withMessageAttributes(java.util.Map* The ID of the SubChannel. *
* * @param subChannelId * The ID of the SubChannel. */ public void setSubChannelId(String subChannelId) { this.subChannelId = subChannelId; } /** ** The ID of the SubChannel. *
* * @return The ID of the SubChannel. */ public String getSubChannelId() { return this.subChannelId; } /** ** The ID of the SubChannel. *
* * @param subChannelId * The ID of the SubChannel. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withSubChannelId(String subChannelId) { setSubChannelId(subChannelId); return this; } /** *
* 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.
*
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.
*/
public void setContentType(String contentType) {
this.contentType = 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.
*
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.
*/
public String getContentType() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChannelMessage withContentType(String contentType) {
setContentType(contentType);
return this;
}
/**
* * 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setTarget(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTarget(java.util.Collection)} or {@link #withTarget(java.util.Collection)} if you want to override the * existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withTarget(Target... target) { if (this.target == null) { setTarget(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ChannelMessage withTarget(java.util.Collection