Class Attendee
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Attendee.Builder,
Attendee>
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId
and JoinToken
. The
JoinToken
allows a client to authenticate and join as the specified attendee. The JoinToken
expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join
the meeting.
We recommend securely transferring each JoinToken
from 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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Chime SDK attendee ID.static Attendee.Builder
builder()
final AttendeeCapabilities
The capabilities assigned to an attendee: audio, video, or content.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Chime SDK external user ID.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The join token used by the Amazon Chime SDK attendee.static Class
<? extends Attendee.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Chime SDK attendee ID.
- Returns:
- The Amazon Chime SDK attendee ID.
-
joinToken
The join token used by the Amazon Chime SDK attendee.
- Returns:
- The join token used by the Amazon Chime SDK attendee.
-
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
SendReceive
data. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
You can't set
content
capabilities toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive. -
When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, 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
SendReceive
data. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
You can't set
content
capabilities toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive. -
When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Attendee.Builder,
Attendee> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-