/*
* 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-meetings-2021-07-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.ChimeSDKMeetings.Model
{
///
/// Container for the parameters to the CreateAttendee operation.
/// Creates a new attendee for an active Amazon Chime SDK meeting. For more information
/// about the Amazon Chime SDK, see Using
/// the Amazon Chime SDK in the Amazon Chime Developer Guide.
///
public partial class CreateAttendeeRequest : AmazonChimeSDKMeetingsRequest
{
private AttendeeCapabilities _capabilities;
private string _externalUserId;
private string _meetingId;
///
/// Gets and sets the property Capabilities.
///
/// The capabilities (audio
, video
, or content
)
/// that you want to grant an attendee. If you don't specify capabilities, all users have
/// send and receive capabilities on all media channels by default.
///
///
///
/// You use the capabilities with a set of values that control what the capabilities can
/// do, such as SendReceive
data. For more information about those values,
/// see .
///
///
///
/// When using capabilities, be aware of these corner cases:
///
/// -
///
/// You can't set
content
capabilities to SendReceive
or Receive
/// unless you also set video
capabilities to SendReceive
or
/// Receive
. If you don't set the video
capability to receive,
/// the response will contain an HTTP 400 Bad Request status code. However, you can set
/// your video
capability to receive and you set your content
/// capability to not receive.
///
/// -
///
/// When you change an
audio
capability from None
or Receive
/// to Send
or SendReceive
, and if the attendee left their
/// microphone unmuted, audio will flow from the attendee to the other meeting participants.
///
/// -
///
/// When you change a
video
or content
capability from None
/// or Receive
to Send
or SendReceive
, and if
/// the attendee turned on their video or content streams, remote attendees can receive
/// those streams, but only after media renegotiation between the client and the Amazon
/// Chime back-end server.
///
///
///
public AttendeeCapabilities Capabilities
{
get { return this._capabilities; }
set { this._capabilities = value; }
}
// Check to see if Capabilities property is set
internal bool IsSetCapabilities()
{
return this._capabilities != null;
}
///
/// Gets and sets the property ExternalUserId.
///
/// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to
/// an identity managed by a builder application.
///
///
///
/// Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
///
///
///
/// Values that begin with aws:
are reserved. You can't configure a value
/// that uses this prefix.
///
///
[AWSProperty(Required=true, Sensitive=true, Min=2, Max=64)]
public string ExternalUserId
{
get { return this._externalUserId; }
set { this._externalUserId = value; }
}
// Check to see if ExternalUserId property is set
internal bool IsSetExternalUserId()
{
return this._externalUserId != null;
}
///
/// Gets and sets the property MeetingId.
///
/// The unique ID of the meeting.
///
///
[AWSProperty(Required=true)]
public string MeetingId
{
get { return this._meetingId; }
set { this._meetingId = value; }
}
// Check to see if MeetingId property is set
internal bool IsSetMeetingId()
{
return this._meetingId != null;
}
}
}