/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the chime-2018-05-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Chime.Model
{
///
/// Container for the parameters to the ListChannelMessages operation.
/// List all the messages in a channel. Returns a paginated list of ChannelMessages
.
/// By default, sorted by creation timestamp in descending order.
///
///
///
/// Redacted messages appear in the results as empty, since they are only redacted, not
/// deleted. Deleted messages do not appear in the results. This action always returns
/// the latest version of an edited message.
///
///
///
/// Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
/// of the user that makes the API call as the value in the header.
///
///
///
/// This API is is no longer supported and will not be updated. We recommend using
/// the latest version, ListChannelMessages,
/// in the Amazon Chime SDK.
///
///
///
/// Using the latest version requires migrating to a dedicated namespace. For more information,
/// refer to Migrating
/// from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
///
///
///
public partial class ListChannelMessagesRequest : AmazonChimeRequest
{
private string _channelArn;
private string _chimeBearer;
private int? _maxResults;
private string _nextToken;
private DateTime? _notAfter;
private DateTime? _notBefore;
private SortOrder _sortOrder;
///
/// Gets and sets the property ChannelArn.
///
/// The ARN of the channel.
///
///
[AWSProperty(Required=true, Min=5, Max=1600)]
public string ChannelArn
{
get { return this._channelArn; }
set { this._channelArn = value; }
}
// Check to see if ChannelArn property is set
internal bool IsSetChannelArn()
{
return this._channelArn != null;
}
///
/// Gets and sets the property ChimeBearer.
///
/// The AppInstanceUserArn
of the user that makes the API call.
///
///
[AWSProperty(Min=5, Max=1600)]
public string ChimeBearer
{
get { return this._chimeBearer; }
set { this._chimeBearer = value; }
}
// Check to see if ChimeBearer property is set
internal bool IsSetChimeBearer()
{
return this._chimeBearer != null;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of messages that you want returned.
///
///
[AWSProperty(Min=1, Max=50)]
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// The token passed by previous API calls until all requested messages are returned.
///
///
[AWSProperty(Sensitive=true, Min=0, Max=2048)]
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
///
/// Gets and sets the property NotAfter.
///
/// The final or ending time stamp for your requested messages.
///
///
public DateTime NotAfter
{
get { return this._notAfter.GetValueOrDefault(); }
set { this._notAfter = value; }
}
// Check to see if NotAfter property is set
internal bool IsSetNotAfter()
{
return this._notAfter.HasValue;
}
///
/// Gets and sets the property NotBefore.
///
/// The initial or starting time stamp for your requested messages.
///
///
public DateTime NotBefore
{
get { return this._notBefore.GetValueOrDefault(); }
set { this._notBefore = value; }
}
// Check to see if NotBefore property is set
internal bool IsSetNotBefore()
{
return this._notBefore.HasValue;
}
///
/// Gets and sets the property SortOrder.
///
/// The order in which you want messages sorted. Default is Descending, based on time
/// created.
///
///
public SortOrder SortOrder
{
get { return this._sortOrder; }
set { this._sortOrder = value; }
}
// Check to see if SortOrder property is set
internal bool IsSetSortOrder()
{
return this._sortOrder != null;
}
}
}