Struct ParticipantSummary 

#[non_exhaustive]
pub struct ParticipantSummary {
    pub participant_id: Option<String>,
    pub user_id: Option<String>,
    pub state: Option<ParticipantState>,
    pub first_join_time: Option<DateTime>,
    pub published: bool,
    pub recording_state: Option<ParticipantRecordingState>,
    pub replication_type: Option<ReplicationType>,
    pub replication_state: Option<ReplicationState>,
    pub source_stage_arn: Option<String>,
    pub source_session_id: Option<String>,
}

Summary object describing a participant that has joined a stage.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

participant_id: Option<String>

Unique identifier for this participant, assigned by IVS.

user_id: Option<String>

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.

state: Option<ParticipantState>

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

first_join_time: Option<DateTime>

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

published: bool

Whether the participant ever published to the stage session.

recording_state: Option<ParticipantRecordingState>

The participant’s recording state.

replication_type: Option<ReplicationType>

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

replication_state: Option<ReplicationState>

The participant's replication state.

source_stage_arn: Option<String>

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

source_session_id: Option<String>

ID of the session within the source stage, if replicationType is REPLICA.

Implementations

impl ParticipantSummary

pub fn participant_id(&self) -> Option<&str>

Unique identifier for this participant, assigned by IVS.

pub fn user_id(&self) -> Option<&str>

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.

pub fn state(&self) -> Option<&ParticipantState>

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

pub fn first_join_time(&self) -> Option<&DateTime>

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

pub fn published(&self) -> bool

Whether the participant ever published to the stage session.

pub fn recording_state(&self) -> Option<&ParticipantRecordingState>

The participant’s recording state.

pub fn replication_type(&self) -> Option<&ReplicationType>

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

pub fn replication_state(&self) -> Option<&ReplicationState>

The participant's replication state.

pub fn source_stage_arn(&self) -> Option<&str>

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

pub fn source_session_id(&self) -> Option<&str>

ID of the session within the source stage, if replicationType is REPLICA.

impl ParticipantSummary

pub fn builder() -> ParticipantSummaryBuilder

Creates a new builder-style object to manufacture ParticipantSummary.

Trait Implementations

impl Clone for ParticipantSummary

fn clone(&self) -> ParticipantSummary

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParticipantSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ParticipantSummary

fn eq(&self, other: &ParticipantSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParticipantSummary