Trait rusoto_connectparticipant::ConnectParticipant

pub trait ConnectParticipant {
#[must_use]    pub fn create_participant_connection<'life0, 'async_trait>(
        &'life0 self, 
        input: CreateParticipantConnectionRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateParticipantConnectionResponse, RusotoError<CreateParticipantConnectionError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn disconnect_participant<'life0, 'async_trait>(
        &'life0 self, 
        input: DisconnectParticipantRequest
    ) -> Pin<Box<dyn Future<Output = Result<DisconnectParticipantResponse, RusotoError<DisconnectParticipantError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn get_transcript<'life0, 'async_trait>(
        &'life0 self, 
        input: GetTranscriptRequest
    ) -> Pin<Box<dyn Future<Output = Result<GetTranscriptResponse, RusotoError<GetTranscriptError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn send_event<'life0, 'async_trait>(
        &'life0 self, 
        input: SendEventRequest
    ) -> Pin<Box<dyn Future<Output = Result<SendEventResponse, RusotoError<SendEventError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn send_message<'life0, 'async_trait>(
        &'life0 self, 
        input: SendMessageRequest
    ) -> Pin<Box<dyn Future<Output = Result<SendMessageResponse, RusotoError<SendMessageError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
}

Trait representing the capabilities of the Amazon Connect Participant API. Amazon Connect Participant clients implement this trait.

Required methods

#[must_use]pub fn create_participant_connection<'life0, 'async_trait>(
    &'life0 self,
    input: CreateParticipantConnectionRequest
) -> Pin<Box<dyn Future<Output = Result<CreateParticipantConnectionResponse, RusotoError<CreateParticipantConnectionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until the they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

#[must_use]pub fn disconnect_participant<'life0, 'async_trait>(
    &'life0 self,
    input: DisconnectParticipantRequest
) -> Pin<Box<dyn Future<Output = Result<DisconnectParticipantResponse, RusotoError<DisconnectParticipantError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

#[must_use]pub fn get_transcript<'life0, 'async_trait>(
    &'life0 self,
    input: GetTranscriptRequest
) -> Pin<Box<dyn Future<Output = Result<GetTranscriptResponse, RusotoError<GetTranscriptError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

#[must_use]pub fn send_event<'life0, 'async_trait>(
    &'life0 self,
    input: SendEventRequest
) -> Pin<Box<dyn Future<Output = Result<SendEventResponse, RusotoError<SendEventError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

#[must_use]pub fn send_message<'life0, 'async_trait>(
    &'life0 self,
    input: SendMessageRequest
) -> Pin<Box<dyn Future<Output = Result<SendMessageResponse, RusotoError<SendMessageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Loading content...

Implementors

impl ConnectParticipant for ConnectParticipantClient

pub fn create_participant_connection<'life0, 'async_trait>(
    &'life0 self,
    input: CreateParticipantConnectionRequest
) -> Pin<Box<dyn Future<Output = Result<CreateParticipantConnectionResponse, RusotoError<CreateParticipantConnectionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until the they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

pub fn disconnect_participant<'life0, 'async_trait>(
    &'life0 self,
    input: DisconnectParticipantRequest
) -> Pin<Box<dyn Future<Output = Result<DisconnectParticipantResponse, RusotoError<DisconnectParticipantError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

pub fn get_transcript<'life0, 'async_trait>(
    &'life0 self,
    input: GetTranscriptRequest
) -> Pin<Box<dyn Future<Output = Result<GetTranscriptResponse, RusotoError<GetTranscriptError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

pub fn send_event<'life0, 'async_trait>(
    &'life0 self,
    input: SendEventRequest
) -> Pin<Box<dyn Future<Output = Result<SendEventResponse, RusotoError<SendEventError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

pub fn send_message<'life0, 'async_trait>(
    &'life0 self,
    input: SendMessageRequest
) -> Pin<Box<dyn Future<Output = Result<SendMessageResponse, RusotoError<SendMessageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Loading content...