Attendee (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.chimesdkmeetings.model.Attendee

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Attendee
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Attendee()

Constructors
Constructor and Description
`Attendee()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Attendee`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAttendeeId()` The Amazon Chime SDK attendee ID.
`AttendeeCapabilities`	`getCapabilities()` The capabilities assigned to an attendee: audio, video, or content.
`String`	`getExternalUserId()` The Amazon Chime SDK external user ID.
`String`	`getJoinToken()` The join token used by the Amazon Chime SDK attendee.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttendeeId(String attendeeId)` The Amazon Chime SDK attendee ID.
`void`	`setCapabilities(AttendeeCapabilities capabilities)` The capabilities assigned to an attendee: audio, video, or content.
`void`	`setExternalUserId(String externalUserId)` The Amazon Chime SDK external user ID.
`void`	`setJoinToken(String joinToken)` The join token used by the Amazon Chime SDK attendee.
`String`	`toString()` Returns a string representation of this object.
`Attendee`	`withAttendeeId(String attendeeId)` The Amazon Chime SDK attendee ID.
`Attendee`	`withCapabilities(AttendeeCapabilities capabilities)` The capabilities assigned to an attendee: audio, video, or content.
`Attendee`	`withExternalUserId(String externalUserId)` The Amazon Chime SDK external user ID.
`Attendee`	`withJoinToken(String joinToken)` The join token used by the Amazon Chime SDK attendee.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Attendee
```
public Attendee()
```
- Method Detail
  - setExternalUserId
```
public void setExternalUserId(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.
    
    Parameters:
    
    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.
  - getExternalUserId
```
public String getExternalUserId()
```
    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.
  - withExternalUserId
```
public Attendee withExternalUserId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAttendeeId
```
public void setAttendeeId(String attendeeId)
```
    The Amazon Chime SDK attendee ID.
    
    Parameters:
    
    attendeeId - The Amazon Chime SDK attendee ID.
  - getAttendeeId
```
public String getAttendeeId()
```
    The Amazon Chime SDK attendee ID.
    
    Returns:
    
    The Amazon Chime SDK attendee ID.
  - withAttendeeId
```
public Attendee withAttendeeId(String attendeeId)
```
    The Amazon Chime SDK attendee ID.
    
    Parameters:
    
    attendeeId - The Amazon Chime SDK attendee ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJoinToken
```
public void setJoinToken(String joinToken)
```
    The join token used by the Amazon Chime SDK attendee.
    
    Parameters:
    
    joinToken - The join token used by the Amazon Chime SDK attendee.
  - getJoinToken
```
public String getJoinToken()
```
    The join token used by the Amazon Chime SDK attendee.
    
    Returns:
    
    The join token used by the Amazon Chime SDK attendee.
  - withJoinToken
```
public Attendee withJoinToken(String joinToken)
```
    The join token used by the Amazon Chime SDK attendee.
    
    Parameters:
    
    joinToken - The join token used by the Amazon Chime SDK attendee.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapabilities
```
public void setCapabilities(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:
    - If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    - If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    - 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.
    Parameters:
    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 include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    
    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    
    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.
  - getCapabilities
```
public AttendeeCapabilities getCapabilities()
```
    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 include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    - If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    - 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:
    
    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    
    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    
    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.
  - withCapabilities
```
public Attendee withCapabilities(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:
    - If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    - If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    - 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.
    Parameters:
    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 include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
    
    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Attendee clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Attendee

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Attendee

Method Detail

setExternalUserId

getExternalUserId

withExternalUserId

setAttendeeId

getAttendeeId

withAttendeeId

setJoinToken

getJoinToken

withJoinToken

setCapabilities

getCapabilities

withCapabilities

toString

equals

hashCode

clone

marshall