ConnectParticipant class

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

Constructors

ConnectParticipant({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

completeAttachmentUpload({required List<String> attachmentIds, required String connectionToken, String? clientToken}) → Future<void>

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

createParticipantConnection({required String participantToken, required List<ConnectionType> type}) → Future<CreateParticipantConnectionResponse>

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

disconnectParticipant({required String connectionToken, String? clientToken}) → Future<void>

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

getAttachment({required String attachmentId, required String connectionToken}) → Future<GetAttachmentResponse>

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

getTranscript({required String connectionToken, String? contactId, int? maxResults, String? nextToken, ScanDirection? scanDirection, SortKey? sortOrder, StartPosition? startPosition}) → Future<GetTranscriptResponse>

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

sendEvent({required String connectionToken, required String contentType, String? clientToken, String? content}) → Future<SendEventResponse>

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

sendMessage({required String connectionToken, required String content, required String contentType, String? clientToken}) → Future<SendMessageResponse>

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

startAttachmentUpload({required String attachmentName, required int attachmentSizeInBytes, required String connectionToken, required String contentType, String? clientToken}) → Future<StartAttachmentUploadResponse>

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited