pub struct CreateChatTokenFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateChatToken.
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities field to permit an end user to send messages or moderate a room.
The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
Implementations§
Source§impl CreateChatTokenFluentBuilder
impl CreateChatTokenFluentBuilder
Sourcepub fn as_input(&self) -> &CreateChatTokenInputBuilder
pub fn as_input(&self) -> &CreateChatTokenInputBuilder
Access the CreateChatToken as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateChatTokenOutput, SdkError<CreateChatTokenError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateChatTokenOutput, SdkError<CreateChatTokenError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateChatTokenOutput, CreateChatTokenError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateChatTokenOutput, CreateChatTokenError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn room_identifier(self, input: impl Into<String>) -> Self
pub fn room_identifier(self, input: impl Into<String>) -> Self
Identifier of the room that the client is trying to access. Currently this must be an ARN.
Sourcepub fn set_room_identifier(self, input: Option<String>) -> Self
pub fn set_room_identifier(self, input: Option<String>) -> Self
Identifier of the room that the client is trying to access. Currently this must be an ARN.
Sourcepub fn get_room_identifier(&self) -> &Option<String>
pub fn get_room_identifier(&self) -> &Option<String>
Identifier of the room that the client is trying to access. Currently this must be an ARN.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
Sourcepub fn capabilities(self, input: ChatTokenCapability) -> Self
pub fn capabilities(self, input: ChatTokenCapability) -> 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 room. Default: None (the capability to view messages is implicitly included in all requests).
Sourcepub fn set_capabilities(self, input: Option<Vec<ChatTokenCapability>>) -> Self
pub fn set_capabilities(self, input: Option<Vec<ChatTokenCapability>>) -> Self
Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
Sourcepub fn get_capabilities(&self) -> &Option<Vec<ChatTokenCapability>>
pub fn get_capabilities(&self) -> &Option<Vec<ChatTokenCapability>>
Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
Sourcepub fn session_duration_in_minutes(self, input: i32) -> Self
pub fn session_duration_in_minutes(self, input: i32) -> Self
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
Sourcepub fn set_session_duration_in_minutes(self, input: Option<i32>) -> Self
pub fn set_session_duration_in_minutes(self, input: Option<i32>) -> Self
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
Sourcepub fn get_session_duration_in_minutes(&self) -> &Option<i32>
pub fn get_session_duration_in_minutes(&self) -> &Option<i32>
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
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 chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
Trait Implementations§
Source§impl Clone for CreateChatTokenFluentBuilder
impl Clone for CreateChatTokenFluentBuilder
Source§fn clone(&self) -> CreateChatTokenFluentBuilder
fn clone(&self) -> CreateChatTokenFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateChatTokenFluentBuilder
impl !RefUnwindSafe for CreateChatTokenFluentBuilder
impl Send for CreateChatTokenFluentBuilder
impl Sync for CreateChatTokenFluentBuilder
impl Unpin for CreateChatTokenFluentBuilder
impl !UnwindSafe for CreateChatTokenFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);