Struct ParticipantToken

#[non_exhaustive]
pub struct ParticipantToken {
    pub participant_id: Option<String>,
    pub token: Option<String>,
    pub user_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub duration: Option<i32>,
    pub capabilities: Option<Vec<ParticipantTokenCapability>>,
    pub expiration_time: Option<DateTime>,
}

Object specifying a participant token in a stage.

Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

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 token, assigned by IVS.

token: Option<String>

The issued client token, encrypted.

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.

attributes: Option<HashMap<String, String>>

Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

duration: Option<i32>

Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

capabilities: Option<Vec<ParticipantTokenCapability>>

Set of capabilities that the user is allowed to perform in the stage.

expiration_time: Option<DateTime>

ISO 8601 timestamp (returned as a string) for when this token expires.

Implementations

impl ParticipantToken

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

Unique identifier for this participant token, assigned by IVS.

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

The issued client token, encrypted.

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 attributes(&self) -> Option<&HashMap<String, String>>

Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

pub fn duration(&self) -> Option<i32>

Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

pub fn capabilities(&self) -> &[ParticipantTokenCapability]

Set of capabilities that the user is allowed to perform in the stage.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capabilities.is_none().

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

ISO 8601 timestamp (returned as a string) for when this token expires.

impl ParticipantToken

pub fn builder() -> ParticipantTokenBuilder

Creates a new builder-style object to manufacture ParticipantToken.

Trait Implementations

impl Clone for ParticipantToken

fn clone(&self) -> ParticipantToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParticipantToken

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

Formats the value using the given formatter.

impl PartialEq for ParticipantToken

fn eq(&self, other: &ParticipantToken) -> 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 ParticipantToken