Package software.amazon.awssdk.services.ivsrealtime.model

Interface Participant.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Participant.Builder,Participant>, SdkBuilder<Participant.Builder,Participant>, SdkPojo
Enclosing class:
Participant
public static interface Participant.Builder extends SdkPojo, CopyableBuilder<Participant.Builder,Participant>

  • Method Details

    • attributes

      Participant.Builder attributes(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserName

      Participant.Builder browserName(String browserName)

      The participant’s browser.

      Parameters:
      browserName - The participant’s browser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserVersion

      Participant.Builder browserVersion(String browserVersion)

      The participant’s browser version.

      Parameters:
      browserVersion - The participant’s browser version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstJoinTime

      Participant.Builder firstJoinTime(Instant firstJoinTime)

      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

      Parameters:
      firstJoinTime - ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ispName

      Participant.Builder ispName(String ispName)

      The participant’s Internet Service Provider.

      Parameters:
      ispName - The participant’s Internet Service Provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • osName

      Participant.Builder osName(String osName)

      The participant’s operating system.

      Parameters:
      osName - The participant’s operating system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • osVersion

      Participant.Builder osVersion(String osVersion)

      The participant’s operating system version.

      Parameters:
      osVersion - The participant’s operating system version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantId

      Participant.Builder participantId(String participantId)

      Unique identifier for this participant, assigned by IVS.

      Parameters:
      participantId - Unique identifier for this participant, assigned by IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • published

      Participant.Builder published(Boolean published)

      Whether the participant ever published to the stage session.

      Parameters:
      published - Whether the participant ever published to the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sdkVersion

      Participant.Builder sdkVersion(String sdkVersion)

      The participant’s SDK version.

      Parameters:
      sdkVersion - The participant’s SDK version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Participant.Builder state(String state)

      Whether the participant is connected to or disconnected from the stage.

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Participant.Builder state(ParticipantState state)

      Whether the participant is connected to or disconnected from the stage.

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userId

      Participant.Builder userId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.