#[non_exhaustive]pub struct AppInstanceUserEndpoint {
pub app_instance_user_arn: Option<String>,
pub endpoint_id: Option<String>,
pub name: Option<String>,
pub type: Option<AppInstanceUserEndpointType>,
pub resource_arn: Option<String>,
pub endpoint_attributes: Option<EndpointAttributes>,
pub created_timestamp: Option<DateTime>,
pub last_updated_timestamp: Option<DateTime>,
pub allow_messages: Option<AllowMessages>,
pub endpoint_state: Option<EndpointState>,
}Expand description
An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
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.app_instance_user_arn: Option<String>The ARN of the AppInstanceUser.
endpoint_id: Option<String>The unique identifier of the AppInstanceUserEndpoint.
name: Option<String>The name of the AppInstanceUserEndpoint.
type: Option<AppInstanceUserEndpointType>The type of the AppInstanceUserEndpoint.
resource_arn: Option<String>The ARN of the resource to which the endpoint belongs.
endpoint_attributes: Option<EndpointAttributes>The attributes of an Endpoint.
created_timestamp: Option<DateTime>The time at which an AppInstanceUserEndpoint was created.
last_updated_timestamp: Option<DateTime>The time at which an AppInstanceUserEndpoint was last updated.
allow_messages: Option<AllowMessages>Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
endpoint_state: Option<EndpointState>A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
-
ACTIVE: TheAppInstanceUserEndpointis active and able to receive messages. WhenACTIVE, theEndpointStatusReasonremains empty. -
INACTIVE: TheAppInstanceUserEndpointis inactive and can't receive message. WhenINACTIVE, the corresponding reason will be conveyed throughEndpointStatusReason. -
INVALID_DEVICE_TOKENindicates that anAppInstanceUserEndpointisINACTIVEdue to invalid device token -
INVALID_PINPOINT_ARNindicates that anAppInstanceUserEndpointisINACTIVEdue to an invalid pinpoint ARN that was input through theResourceArnfield.
Implementations§
Source§impl AppInstanceUserEndpoint
impl AppInstanceUserEndpoint
Sourcepub fn app_instance_user_arn(&self) -> Option<&str>
pub fn app_instance_user_arn(&self) -> Option<&str>
The ARN of the AppInstanceUser.
Sourcepub fn endpoint_id(&self) -> Option<&str>
pub fn endpoint_id(&self) -> Option<&str>
The unique identifier of the AppInstanceUserEndpoint.
Sourcepub fn type(&self) -> Option<&AppInstanceUserEndpointType>
pub fn type(&self) -> Option<&AppInstanceUserEndpointType>
The type of the AppInstanceUserEndpoint.
Sourcepub fn resource_arn(&self) -> Option<&str>
pub fn resource_arn(&self) -> Option<&str>
The ARN of the resource to which the endpoint belongs.
Sourcepub fn endpoint_attributes(&self) -> Option<&EndpointAttributes>
pub fn endpoint_attributes(&self) -> Option<&EndpointAttributes>
The attributes of an Endpoint.
Sourcepub fn created_timestamp(&self) -> Option<&DateTime>
pub fn created_timestamp(&self) -> Option<&DateTime>
The time at which an AppInstanceUserEndpoint was created.
Sourcepub fn last_updated_timestamp(&self) -> Option<&DateTime>
pub fn last_updated_timestamp(&self) -> Option<&DateTime>
The time at which an AppInstanceUserEndpoint was last updated.
Sourcepub fn allow_messages(&self) -> Option<&AllowMessages>
pub fn allow_messages(&self) -> Option<&AllowMessages>
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
Sourcepub fn endpoint_state(&self) -> Option<&EndpointState>
pub fn endpoint_state(&self) -> Option<&EndpointState>
A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
-
ACTIVE: TheAppInstanceUserEndpointis active and able to receive messages. WhenACTIVE, theEndpointStatusReasonremains empty. -
INACTIVE: TheAppInstanceUserEndpointis inactive and can't receive message. WhenINACTIVE, the corresponding reason will be conveyed throughEndpointStatusReason. -
INVALID_DEVICE_TOKENindicates that anAppInstanceUserEndpointisINACTIVEdue to invalid device token -
INVALID_PINPOINT_ARNindicates that anAppInstanceUserEndpointisINACTIVEdue to an invalid pinpoint ARN that was input through theResourceArnfield.
Source§impl AppInstanceUserEndpoint
impl AppInstanceUserEndpoint
Sourcepub fn builder() -> AppInstanceUserEndpointBuilder
pub fn builder() -> AppInstanceUserEndpointBuilder
Creates a new builder-style object to manufacture AppInstanceUserEndpoint.
Trait Implementations§
Source§impl Clone for AppInstanceUserEndpoint
impl Clone for AppInstanceUserEndpoint
Source§fn clone(&self) -> AppInstanceUserEndpoint
fn clone(&self) -> AppInstanceUserEndpoint
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AppInstanceUserEndpoint
impl Debug for AppInstanceUserEndpoint
Source§impl PartialEq for AppInstanceUserEndpoint
impl PartialEq for AppInstanceUserEndpoint
impl StructuralPartialEq for AppInstanceUserEndpoint
Auto Trait Implementations§
impl Freeze for AppInstanceUserEndpoint
impl RefUnwindSafe for AppInstanceUserEndpoint
impl Send for AppInstanceUserEndpoint
impl Sync for AppInstanceUserEndpoint
impl Unpin for AppInstanceUserEndpoint
impl UnwindSafe for AppInstanceUserEndpoint
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);