Struct ParticipantTokenBuilder 

#[non_exhaustive]
pub struct ParticipantTokenBuilder { /* private fields */ }

A builder for ParticipantToken.

Implementations

impl ParticipantTokenBuilder

pub fn participant_id(self, input: impl Into<String>) -> Self

Unique identifier for this participant token, assigned by IVS.

pub fn set_participant_id(self, input: Option<String>) -> Self

Unique identifier for this participant token, assigned by IVS.

pub fn get_participant_id(&self) -> &Option<String>

Unique identifier for this participant token, assigned by IVS.

pub fn token(self, input: impl Into<String>) -> Self

The issued client token, encrypted.

pub fn set_token(self, input: Option<String>) -> Self

The issued client token, encrypted.

pub fn get_token(&self) -> &Option<String>

The issued client token, encrypted.

pub fn user_id(self, input: impl Into<String>) -> Self

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 set_user_id(self, input: Option<String>) -> Self

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 get_user_id(&self) -> &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.

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to attributes.

To override the contents of this collection use set_attributes.

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 set_attributes(self, input: Option<HashMap<String, String>>) -> Self

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 get_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, input: i32) -> Self

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

pub fn set_duration(self, input: Option<i32>) -> Self

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

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

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

pub fn capabilities(self, input: ParticipantTokenCapability) -> Self

Appends an item to capabilities.

To override the contents of this collection use set_capabilities.

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

pub fn set_capabilities( self, input: Option<Vec<ParticipantTokenCapability>>, ) -> Self

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

pub fn get_capabilities(&self) -> &Option<Vec<ParticipantTokenCapability>>

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

pub fn expiration_time(self, input: DateTime) -> Self

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

pub fn set_expiration_time(self, input: Option<DateTime>) -> Self

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

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

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

pub fn build(self) -> ParticipantToken

Consumes the builder and constructs a ParticipantToken.

Trait Implementations

impl Clone for ParticipantTokenBuilder

fn clone(&self) -> ParticipantTokenBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParticipantTokenBuilder

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

Formats the value using the given formatter.

impl Default for ParticipantTokenBuilder

fn default() -> ParticipantTokenBuilder

Returns the “default value” for a type.

impl PartialEq for ParticipantTokenBuilder

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