#[non_exhaustive]pub struct ParticipantTokenConfiguration {
pub duration: Option<i32>,
pub user_id: Option<String>,
pub attributes: Option<HashMap<String, String>>,
pub capabilities: Option<Vec<ParticipantTokenCapability>>,
}
Expand description
Object specifying a participant token configuration in a stage.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.duration: Option<i32>
Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
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 corresponding participant 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.
capabilities: Option<Vec<ParticipantTokenCapability>>
Set of capabilities that the user is allowed to perform in the stage.
Implementations§
source§impl ParticipantTokenConfiguration
impl ParticipantTokenConfiguration
sourcepub fn duration(&self) -> Option<i32>
pub fn duration(&self) -> Option<i32>
Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
sourcepub fn user_id(&self) -> Option<&str>
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.
sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> Option<&HashMap<String, String>>
Application-provided attributes to encode into the corresponding participant 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.
sourcepub fn capabilities(&self) -> &[ParticipantTokenCapability]
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()
.
source§impl ParticipantTokenConfiguration
impl ParticipantTokenConfiguration
sourcepub fn builder() -> ParticipantTokenConfigurationBuilder
pub fn builder() -> ParticipantTokenConfigurationBuilder
Creates a new builder-style object to manufacture ParticipantTokenConfiguration
.
Trait Implementations§
source§impl Clone for ParticipantTokenConfiguration
impl Clone for ParticipantTokenConfiguration
source§fn clone(&self) -> ParticipantTokenConfiguration
fn clone(&self) -> ParticipantTokenConfiguration
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for ParticipantTokenConfiguration
impl PartialEq for ParticipantTokenConfiguration
source§fn eq(&self, other: &ParticipantTokenConfiguration) -> bool
fn eq(&self, other: &ParticipantTokenConfiguration) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ParticipantTokenConfiguration
Auto Trait Implementations§
impl Freeze for ParticipantTokenConfiguration
impl RefUnwindSafe for ParticipantTokenConfiguration
impl Send for ParticipantTokenConfiguration
impl Sync for ParticipantTokenConfiguration
impl Unpin for ParticipantTokenConfiguration
impl UnwindSafe for ParticipantTokenConfiguration
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more