Attendee (AWS Java SDK :: Services :: Chime SDK Meetings 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.chimesdkmeetings.model.Attendee

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Attendee.Builder,Attendee>
```
@Generated(value="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 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Attendee.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Attendee.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`attendeeId()` The Amazon Chime SDK attendee ID.
`static Attendee.Builder`	`builder()`
`AttendeeCapabilities`	`capabilities()` The capabilities assigned to an attendee: audio, video, or content.
`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`	`joinToken()` The join token used by the Amazon Chime SDK attendee.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Attendee.Builder>`	`serializableBuilderClass()`
`Attendee.Builder`	`toBuilder()`
`String`	`toString()` 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 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.
    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:
    
    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.
  - toBuilder
```
public Attendee.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Attendee.Builder,Attendee>
  - builder
```
public static Attendee.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Attendee.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Attendee

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

externalUserId

attendeeId

joinToken

capabilities

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields