Class Attendee
- java.lang.Object
-
- software.amazon.awssdk.services.chimesdkmeetings.model.Attendee
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Attendee.Builder,Attendee>
@Generated("software.amazon.awssdk:codegen") public final class Attendee extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Attendee.Builder,Attendee>
An Amazon Chime SDK meeting attendee. Includes a unique
AttendeeIdandJoinToken. TheJoinTokenallows a client to authenticate and join as the specified attendee. TheJoinTokenexpires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.We recommend securely transferring each
JoinTokenfrom your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAttendee.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringattendeeId()The Amazon Chime SDK attendee ID.static Attendee.Builderbuilder()AttendeeCapabilitiescapabilities()The capabilities assigned to an attendee: audio, video, or content.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalUserId()The Amazon Chime SDK external user ID.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringjoinToken()The join token used by the Amazon Chime SDK attendee.List<SdkField<?>>sdkFields()static Class<? extends Attendee.Builder>serializableBuilderClass()Attendee.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
externalUserId
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. Case insensitive.- Returns:
- 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. Case insensitive.
-
attendeeId
public final String attendeeId()
The Amazon Chime SDK attendee ID.
- Returns:
- The Amazon Chime SDK attendee ID.
-
joinToken
public final String joinToken()
The join token used by the Amazon Chime SDK attendee.
- Returns:
- The join token used by the Amazon Chime SDK attendee.
-
capabilities
public final AttendeeCapabilities capabilities()
The capabilities assigned to an attendee: audio, video, or content.
You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.
- Returns:
- The capabilities assigned to an attendee: audio, video, or content.
You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.
-
-
-
toBuilder
public Attendee.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Attendee.Builder,Attendee>
-
builder
public static Attendee.Builder builder()
-
serializableBuilderClass
public static Class<? extends Attendee.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-