@Generated(value="software.amazon.awssdk:codegen") public final class CreateAttendeeRequest extends ChimeSdkMeetingsRequest implements ToCopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateAttendeeRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateAttendeeRequest.Builder |
builder() |
AttendeeCapabilities |
capabilities()
The capabilities (
audio, video, or content) that you want to grant an
attendee. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
externalUserId()
The Amazon Chime SDK external user ID.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
meetingId()
The unique ID of the meeting.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAttendeeRequest.Builder> |
serializableBuilderClass() |
CreateAttendeeRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String meetingId()
The unique ID of the meeting.
public final String 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.
Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
Values that begin with aws: are reserved. You can't configure a value that uses this prefix.
public final AttendeeCapabilities 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.
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 CreateAttendeeRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>toBuilder in class ChimeSdkMeetingsRequestpublic static CreateAttendeeRequest.Builder builder()
public static Class<? extends CreateAttendeeRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.