ParticipantToken (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ivsrealtime.model.ParticipantToken

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParticipantToken
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Object specifying a participant token in a stage.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ParticipantToken()

Constructors
Constructor and Description
`ParticipantToken()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParticipantToken`	`addAttributesEntry(String key, String value)` Add a single Attributes entry
`ParticipantToken`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`ParticipantToken`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` Application-provided attributes to encode into the token and attach to a stage.
`List<String>`	`getCapabilities()` Set of capabilities that the user is allowed to perform in the stage.
`Integer`	`getDuration()` Duration (in minutes), after which the participant token expires.
`Date`	`getExpirationTime()` ISO 8601 timestamp (returned as a string) for when this token expires.
`String`	`getParticipantId()` Unique identifier for this participant token, assigned by IVS.
`String`	`getToken()` The issued client token, encrypted.
`String`	`getUserId()` Name to help identify the token.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,String> attributes)` Application-provided attributes to encode into the token and attach to a stage.
`void`	`setCapabilities(Collection<String> capabilities)` Set of capabilities that the user is allowed to perform in the stage.
`void`	`setDuration(Integer duration)` Duration (in minutes), after which the participant token expires.
`void`	`setExpirationTime(Date expirationTime)` ISO 8601 timestamp (returned as a string) for when this token expires.
`void`	`setParticipantId(String participantId)` Unique identifier for this participant token, assigned by IVS.
`void`	`setToken(String token)` The issued client token, encrypted.
`void`	`setUserId(String userId)` Name to help identify the token.
`String`	`toString()` Returns a string representation of this object.
`ParticipantToken`	`withAttributes(Map<String,String> attributes)` Application-provided attributes to encode into the token and attach to a stage.
`ParticipantToken`	`withCapabilities(Collection<String> capabilities)` Set of capabilities that the user is allowed to perform in the stage.
`ParticipantToken`	`withCapabilities(ParticipantTokenCapability... capabilities)` Set of capabilities that the user is allowed to perform in the stage.
`ParticipantToken`	`withCapabilities(String... capabilities)` Set of capabilities that the user is allowed to perform in the stage.
`ParticipantToken`	`withDuration(Integer duration)` Duration (in minutes), after which the participant token expires.
`ParticipantToken`	`withExpirationTime(Date expirationTime)` ISO 8601 timestamp (returned as a string) for when this token expires.
`ParticipantToken`	`withParticipantId(String participantId)` Unique identifier for this participant token, assigned by IVS.
`ParticipantToken`	`withToken(String token)` The issued client token, encrypted.
`ParticipantToken`	`withUserId(String userId)` Name to help identify the token.

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

- Constructor Detail
  - ParticipantToken
```
public ParticipantToken()
```
- Method Detail
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Returns:
    
    Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Parameters:
    
    attributes - Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - withAttributes
```
public ParticipantToken withAttributes(Map<String,String> attributes)
```
    Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Parameters:
    
    attributes - Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public ParticipantToken addAttributesEntry(String key,
                                           String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public ParticipantToken clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCapabilities
```
public List<String> getCapabilities()
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    Returns:
    
    Set of capabilities that the user is allowed to perform in the stage.
    
    See Also:
    
    ParticipantTokenCapability
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    Parameters:
    
    capabilities - Set of capabilities that the user is allowed to perform in the stage.
    
    See Also:
    
    ParticipantTokenCapability
  - withCapabilities
```
public ParticipantToken withCapabilities(String... capabilities)
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    NOTE: This method appends the values to the existing list (if any). Use setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    capabilities - Set of capabilities that the user is allowed to perform in the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantTokenCapability
  - withCapabilities
```
public ParticipantToken withCapabilities(Collection<String> capabilities)
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    Parameters:
    
    capabilities - Set of capabilities that the user is allowed to perform in the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantTokenCapability
  - withCapabilities
```
public ParticipantToken withCapabilities(ParticipantTokenCapability... capabilities)
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    Parameters:
    
    capabilities - Set of capabilities that the user is allowed to perform in the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantTokenCapability
  - setDuration
```
public void setDuration(Integer duration)
```
    Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
    
    Parameters:
    
    duration - Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
  - getDuration
```
public Integer getDuration()
```
    Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
    
    Returns:
    
    Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
  - withDuration
```
public ParticipantToken withDuration(Integer duration)
```
    Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
    
    Parameters:
    
    duration - Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationTime
```
public void setExpirationTime(Date expirationTime)
```
    ISO 8601 timestamp (returned as a string) for when this token expires.
    
    Parameters:
    
    expirationTime - ISO 8601 timestamp (returned as a string) for when this token expires.
  - getExpirationTime
```
public Date getExpirationTime()
```
    ISO 8601 timestamp (returned as a string) for when this token expires.
    
    Returns:
    
    ISO 8601 timestamp (returned as a string) for when this token expires.
  - withExpirationTime
```
public ParticipantToken withExpirationTime(Date expirationTime)
```
    ISO 8601 timestamp (returned as a string) for when this token expires.
    
    Parameters:
    
    expirationTime - ISO 8601 timestamp (returned as a string) for when this token expires.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParticipantId
```
public void setParticipantId(String participantId)
```
    Unique identifier for this participant token, assigned by IVS.
    
    Parameters:
    
    participantId - Unique identifier for this participant token, assigned by IVS.
  - getParticipantId
```
public String getParticipantId()
```
    Unique identifier for this participant token, assigned by IVS.
    
    Returns:
    
    Unique identifier for this participant token, assigned by IVS.
  - withParticipantId
```
public ParticipantToken withParticipantId(String participantId)
```
    Unique identifier for this participant token, assigned by IVS.
    
    Parameters:
    
    participantId - Unique identifier for this participant token, assigned by IVS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToken
```
public void setToken(String token)
```
    The issued client token, encrypted.
    
    Parameters:
    
    token - The issued client token, encrypted.
  - getToken
```
public String getToken()
```
    The issued client token, encrypted.
    
    Returns:
    
    The issued client token, encrypted.
  - withToken
```
public ParticipantToken withToken(String token)
```
    The issued client token, encrypted.
    
    Parameters:
    
    token - The issued client token, encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserId
```
public void setUserId(String userId)
```
    Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Parameters:
    
    userId - Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - getUserId
```
public String getUserId()
```
    Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Returns:
    
    Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - withUserId
```
public ParticipantToken withUserId(String userId)
```
    Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    Parameters:
    
    userId - Name to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    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 ParticipantToken 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.

Did this page help you?

Class ParticipantToken

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticipantToken

Method Detail

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getCapabilities

setCapabilities

withCapabilities

withCapabilities

withCapabilities

setDuration

getDuration

withDuration

setExpirationTime

getExpirationTime

withExpirationTime

setParticipantId

getParticipantId

withParticipantId

setToken

getToken

withToken

setUserId

getUserId

withUserId

toString

equals

hashCode

clone

marshall