Class Participant
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Participant.Builder,
Participant>
Object describing a participant that has joined a stage.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionApplication-provided attributes to encode into the token and attach to a stage.final String
The participant’s browser.final String
The participant’s browser version.static Participant.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final String
ispName()
The participant’s Internet Service Provider.final String
osName()
The participant’s operating system.final String
The participant’s operating system version.final String
Unique identifier for this participant, assigned by IVS.final Boolean
Whether the participant ever published to the stage session.final String
The participant’s SDK version.static Class
<? extends Participant.Builder> final ParticipantState
state()
Whether the participant is connected to or disconnected from the stage.final String
Whether the participant is connected to or disconnected from the stage.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.final 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- 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.
-
browserName
The participant’s browser.
- Returns:
- The participant’s browser.
-
browserVersion
The participant’s browser version.
- Returns:
- The participant’s browser version.
-
firstJoinTime
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
- Returns:
- ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
-
ispName
The participant’s Internet Service Provider.
- Returns:
- The participant’s Internet Service Provider.
-
osName
The participant’s operating system.
- Returns:
- The participant’s operating system.
-
osVersion
The participant’s operating system version.
- Returns:
- The participant’s operating system version.
-
participantId
Unique identifier for this participant, assigned by IVS.
- Returns:
- Unique identifier for this participant, assigned by IVS.
-
published
Whether the participant ever published to the stage session.
- Returns:
- Whether the participant ever published to the stage session.
-
sdkVersion
The participant’s SDK version.
- Returns:
- The participant’s SDK version.
-
state
Whether the participant is connected to or disconnected from the stage.
If the service returns an enum value that is not available in the current SDK version,
state
will returnParticipantState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Whether the participant is connected to or disconnected from the stage.
- See Also:
-
stateAsString
Whether the participant is connected to or disconnected from the stage.
If the service returns an enum value that is not available in the current SDK version,
state
will returnParticipantState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Whether the participant is connected to or disconnected from the stage.
- See Also:
-
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.
- Returns:
- 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.
-
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<Participant.Builder,
Participant> - 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
-