@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Participant extends Object implements Serializable, Cloneable, StructuredPojo
Object describing a participant that has joined a stage.
Constructor and Description |
---|
Participant() |
Modifier and Type | Method and Description |
---|---|
Participant |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
Participant |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
Participant |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
Application-provided attributes to encode into the token and attach to a stage.
|
String |
getBrowserName()
The participant’s browser.
|
String |
getBrowserVersion()
The participant’s browser version.
|
Date |
getFirstJoinTime()
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
String |
getIspName()
The participant’s Internet Service Provider.
|
String |
getOsName()
The participant’s operating system.
|
String |
getOsVersion()
The participant’s operating system version.
|
String |
getParticipantId()
Unique identifier for this participant, assigned by IVS.
|
Boolean |
getPublished()
Whether the participant ever published to the stage session.
|
String |
getSdkVersion()
The participant’s SDK version.
|
String |
getState()
Whether the participant is connected to or disconnected from the stage.
|
String |
getUserId()
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the
customer’s own systems.
|
int |
hashCode() |
Boolean |
isPublished()
Whether the participant ever published to the stage session.
|
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 |
setBrowserName(String browserName)
The participant’s browser.
|
void |
setBrowserVersion(String browserVersion)
The participant’s browser version.
|
void |
setFirstJoinTime(Date firstJoinTime)
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
void |
setIspName(String ispName)
The participant’s Internet Service Provider.
|
void |
setOsName(String osName)
The participant’s operating system.
|
void |
setOsVersion(String osVersion)
The participant’s operating system version.
|
void |
setParticipantId(String participantId)
Unique identifier for this participant, assigned by IVS.
|
void |
setPublished(Boolean published)
Whether the participant ever published to the stage session.
|
void |
setSdkVersion(String sdkVersion)
The participant’s SDK version.
|
void |
setState(String state)
Whether the participant is connected to or disconnected from the stage.
|
void |
setUserId(String userId)
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the
customer’s own systems.
|
String |
toString()
Returns a string representation of this object.
|
Participant |
withAttributes(Map<String,String> attributes)
Application-provided attributes to encode into the token and attach to a stage.
|
Participant |
withBrowserName(String browserName)
The participant’s browser.
|
Participant |
withBrowserVersion(String browserVersion)
The participant’s browser version.
|
Participant |
withFirstJoinTime(Date firstJoinTime)
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
Participant |
withIspName(String ispName)
The participant’s Internet Service Provider.
|
Participant |
withOsName(String osName)
The participant’s operating system.
|
Participant |
withOsVersion(String osVersion)
The participant’s operating system version.
|
Participant |
withParticipantId(String participantId)
Unique identifier for this participant, assigned by IVS.
|
Participant |
withPublished(Boolean published)
Whether the participant ever published to the stage session.
|
Participant |
withSdkVersion(String sdkVersion)
The participant’s SDK version.
|
Participant |
withState(ParticipantState state)
Whether the participant is connected to or disconnected from the stage.
|
Participant |
withState(String state)
Whether the participant is connected to or disconnected from the stage.
|
Participant |
withUserId(String userId)
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the
customer’s own systems.
|
public Map<String,String> getAttributes()
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
public void setAttributes(Map<String,String> attributes)
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
attributes
- Application-provided attributes to encode into the token and attach to a stage. Map keys and values can
contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to
all stage participants and should not be used for personally identifying, confidential, or sensitive
information.public Participant withAttributes(Map<String,String> attributes)
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
attributes
- Application-provided attributes to encode into the token and attach to a stage. Map keys and values can
contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to
all stage participants and should not be used for personally identifying, confidential, or sensitive
information.public Participant addAttributesEntry(String key, String value)
public Participant clearAttributesEntries()
public void setBrowserName(String browserName)
The participant’s browser.
browserName
- The participant’s browser.public String getBrowserName()
The participant’s browser.
public Participant withBrowserName(String browserName)
The participant’s browser.
browserName
- The participant’s browser.public void setBrowserVersion(String browserVersion)
The participant’s browser version.
browserVersion
- The participant’s browser version.public String getBrowserVersion()
The participant’s browser version.
public Participant withBrowserVersion(String browserVersion)
The participant’s browser version.
browserVersion
- The participant’s browser version.public void setFirstJoinTime(Date firstJoinTime)
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
firstJoinTime
- ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.public Date getFirstJoinTime()
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
public Participant withFirstJoinTime(Date firstJoinTime)
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
firstJoinTime
- ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.public void setIspName(String ispName)
The participant’s Internet Service Provider.
ispName
- The participant’s Internet Service Provider.public String getIspName()
The participant’s Internet Service Provider.
public Participant withIspName(String ispName)
The participant’s Internet Service Provider.
ispName
- The participant’s Internet Service Provider.public void setOsName(String osName)
The participant’s operating system.
osName
- The participant’s operating system.public String getOsName()
The participant’s operating system.
public Participant withOsName(String osName)
The participant’s operating system.
osName
- The participant’s operating system.public void setOsVersion(String osVersion)
The participant’s operating system version.
osVersion
- The participant’s operating system version.public String getOsVersion()
The participant’s operating system version.
public Participant withOsVersion(String osVersion)
The participant’s operating system version.
osVersion
- The participant’s operating system version.public void setParticipantId(String participantId)
Unique identifier for this participant, assigned by IVS.
participantId
- Unique identifier for this participant, assigned by IVS.public String getParticipantId()
Unique identifier for this participant, assigned by IVS.
public Participant withParticipantId(String participantId)
Unique identifier for this participant, assigned by IVS.
participantId
- Unique identifier for this participant, assigned by IVS.public void setPublished(Boolean published)
Whether the participant ever published to the stage session.
published
- Whether the participant ever published to the stage session.public Boolean getPublished()
Whether the participant ever published to the stage session.
public Participant withPublished(Boolean published)
Whether the participant ever published to the stage session.
published
- Whether the participant ever published to the stage session.public Boolean isPublished()
Whether the participant ever published to the stage session.
public void setSdkVersion(String sdkVersion)
The participant’s SDK version.
sdkVersion
- The participant’s SDK version.public String getSdkVersion()
The participant’s SDK version.
public Participant withSdkVersion(String sdkVersion)
The participant’s SDK version.
sdkVersion
- The participant’s SDK version.public void setState(String state)
Whether the participant is connected to or disconnected from the stage.
state
- Whether the participant is connected to or disconnected from the stage.ParticipantState
public String getState()
Whether the participant is connected to or disconnected from the stage.
ParticipantState
public Participant withState(String state)
Whether the participant is connected to or disconnected from the stage.
state
- Whether the participant is connected to or disconnected from the stage.ParticipantState
public Participant withState(ParticipantState state)
Whether the participant is connected to or disconnected from the stage.
state
- Whether the participant is connected to or disconnected from the stage.ParticipantState
public void setUserId(String userId)
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. 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.
userId
- Customer-assigned name to help identify the token; this can be used to link a participant to a user in the
customer’s own systems. 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.public String getUserId()
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. 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.
public Participant withUserId(String userId)
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. 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.
userId
- Customer-assigned name to help identify the token; this can be used to link a participant to a user in the
customer’s own systems. 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.public String toString()
toString
in class Object
Object.toString()
public Participant clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.