pub struct ListChannelBansFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListChannelBans
.
Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Implementationsยง
sourceยงimpl ListChannelBansFluentBuilder
impl ListChannelBansFluentBuilder
sourcepub fn as_input(&self) -> &ListChannelBansInputBuilder
pub fn as_input(&self) -> &ListChannelBansInputBuilder
Access the ListChannelBans as a reference.
sourcepub async fn send(
self
) -> Result<ListChannelBansOutput, SdkError<ListChannelBansError, HttpResponse>>
pub async fn send( self ) -> Result<ListChannelBansOutput, SdkError<ListChannelBansError, 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<ListChannelBansOutput, ListChannelBansError, Self>
pub fn customize( self ) -> CustomizableOperation<ListChannelBansOutput, ListChannelBansError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListChannelBansPaginator
pub fn into_paginator(self) -> ListChannelBansPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
The ARN of the channel.
sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
The ARN of the channel.
sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
The ARN of the channel.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of bans that you want returned.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of bans that you want returned.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of bans that you want returned.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The token passed by previous API calls until all requested bans are returned.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The token passed by previous API calls until all requested bans are returned.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The token passed by previous API calls until all requested bans are returned.
sourcepub fn chime_bearer(self, input: impl Into<String>) -> Self
pub fn chime_bearer(self, input: impl Into<String>) -> Self
The AppInstanceUserArn
of the user that makes the API call.
sourcepub fn set_chime_bearer(self, input: Option<String>) -> Self
pub fn set_chime_bearer(self, input: Option<String>) -> Self
The AppInstanceUserArn
of the user that makes the API call.
sourcepub fn get_chime_bearer(&self) -> &Option<String>
pub fn get_chime_bearer(&self) -> &Option<String>
The AppInstanceUserArn
of the user that makes the API call.
Trait Implementationsยง
sourceยงimpl Clone for ListChannelBansFluentBuilder
impl Clone for ListChannelBansFluentBuilder
sourceยงfn clone(&self) -> ListChannelBansFluentBuilder
fn clone(&self) -> ListChannelBansFluentBuilder
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 ListChannelBansFluentBuilder
impl !RefUnwindSafe for ListChannelBansFluentBuilder
impl Send for ListChannelBansFluentBuilder
impl Sync for ListChannelBansFluentBuilder
impl Unpin for ListChannelBansFluentBuilder
impl !UnwindSafe for ListChannelBansFluentBuilder
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