/*
* 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-sdk-messaging-2021-05-15.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.ChimeSDKMessaging.Model
{
///
/// Container for the parameters to the CreateChannelMembership operation.
/// Adds a member to a channel. The InvitedBy
field in ChannelMembership
/// is derived from the request header. A channel member can:
///
/// -
///
/// List messages
///
///
-
///
/// Send messages
///
///
-
///
/// Receive messages
///
///
-
///
/// Edit their own messages
///
///
-
///
/// Leave the channel
///
///
///
/// Privacy settings impact this action as follows:
///
/// -
///
/// Public Channels: You do not need to be a member to list messages, but you must be
/// a member to send messages.
///
///
-
///
/// Private Channels: You must be a member to list or send messages.
///
///
///
/// The x-amz-chime-bearer
request header is mandatory. Use the ARN of the
/// AppInstanceUserArn
or AppInstanceBot
that makes the API
/// call as the value in the header.
///
///
///
public partial class CreateChannelMembershipRequest : AmazonChimeSDKMessagingRequest
{
private string _channelArn;
private string _chimeBearer;
private string _memberArn;
private string _subChannelId;
private ChannelMembershipType _type;
///
/// Gets and sets the property ChannelArn.
///
/// The ARN of the channel to which you're adding users.
///
///
[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 ARN of the AppInstanceUser
or AppInstanceBot
that makes
/// the API call.
///
///
[AWSProperty(Required=true, 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 MemberArn.
///
/// The AppInstanceUserArn
of the member you want to add to the channel.
///
///
[AWSProperty(Required=true, Min=5, Max=1600)]
public string MemberArn
{
get { return this._memberArn; }
set { this._memberArn = value; }
}
// Check to see if MemberArn property is set
internal bool IsSetMemberArn()
{
return this._memberArn != null;
}
///
/// Gets and sets the property SubChannelId.
///
/// The ID of the SubChannel in the request.
///
///
///
/// Only required when creating membership in a SubChannel for a moderator in an elastic
/// channel.
///
///
///
[AWSProperty(Min=1, Max=128)]
public string SubChannelId
{
get { return this._subChannelId; }
set { this._subChannelId = value; }
}
// Check to see if SubChannelId property is set
internal bool IsSetSubChannelId()
{
return this._subChannelId != null;
}
///
/// Gets and sets the property Type.
///
/// The membership type of a user, DEFAULT
or HIDDEN
. Default
/// members are always returned as part of ListChannelMemberships
. Hidden
/// members are only returned if the type filter in ListChannelMemberships
/// equals HIDDEN
. Otherwise hidden members are not returned. This is only
/// supported by moderators.
///
///
[AWSProperty(Required=true)]
public ChannelMembershipType Type
{
get { return this._type; }
set { this._type = value; }
}
// Check to see if Type property is set
internal bool IsSetType()
{
return this._type != null;
}
}
}