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

Interface ParticipantSummary.Builder

    • Method Detail

      • participantId

        ParticipantSummary.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.

      • userId

        ParticipantSummary.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.

      • state

        ParticipantSummary.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:
        ParticipantState, ParticipantState

      • firstJoinTime

        ParticipantSummary.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.

      • published

        ParticipantSummary.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.