AWSConnectParticipant Class Reference


                    
                    
                    configuration

The service configuration used to instantiate this service client.

Warning

Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declaration

Objective-C

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration


                    
                    
                    +defaultConnectParticipant

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

Then call the following to get the default service client:

Swift

let ConnectParticipant = AWSConnectParticipant.default()

Objective-C

AWSConnectParticipant *ConnectParticipant = [AWSConnectParticipant defaultConnectParticipant];

Declaration

Objective-C

+ (nonnull instancetype)defaultConnectParticipant;

Swift

class func `default`() -> Self

Return Value

The default service client.


                    
                    
                    +registerConnectParticipantWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSConnectParticipant.register(with: configuration!, forKey: "USWest2ConnectParticipant")

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSConnectParticipant registerConnectParticipantWithConfiguration:configuration forKey:@"USWest2ConnectParticipant"];

    return YES;
}

Then call the following to get the service client:

Swift

let ConnectParticipant = AWSConnectParticipant(forKey: "USWest2ConnectParticipant")

Objective-C

AWSConnectParticipant *ConnectParticipant = [AWSConnectParticipant ConnectParticipantForKey:@"USWest2ConnectParticipant"];

Warning

After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declaration

Objective-C

+ (void)registerConnectParticipantWithConfiguration:(id)configuration
                                             forKey:(nonnull NSString *)key;

Swift

class func register(withConfiguration configuration: Any!, forKey key: String)

Parameters

`configuration`	A service configuration object.
`key`	A string to identify the service client.


                    
                    
                    +ConnectParticipantForKey:

Retrieves the service client associated with the key. You need to call + registerConnectParticipantWithConfiguration:forKey: before invoking this method.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSConnectParticipant.register(with: configuration!, forKey: "USWest2ConnectParticipant")

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSConnectParticipant registerConnectParticipantWithConfiguration:configuration forKey:@"USWest2ConnectParticipant"];

    return YES;
}

Then call the following to get the service client:

Swift

let ConnectParticipant = AWSConnectParticipant(forKey: "USWest2ConnectParticipant")

Objective-C

AWSConnectParticipant *ConnectParticipant = [AWSConnectParticipant ConnectParticipantForKey:@"USWest2ConnectParticipant"];

Declaration

Objective-C

+ (nonnull instancetype)ConnectParticipantForKey:(nonnull NSString *)key;

Swift

convenience init(forKey key: String)

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.


                    
                    
                    +removeConnectParticipantForKey:

Removes the service client associated with the key and release it.

Warning

Before calling this method, make sure no method is running on this client.

Declaration

Objective-C

+ (void)removeConnectParticipantForKey:(nonnull NSString *)key;

Swift

class func remove(forKey key: String)

Parameters

key

A string to identify the service client.


                    
                    
                    -completeAttachmentUpload:

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See

AWSConnectParticipantCompleteAttachmentUploadRequest

See

AWSConnectParticipantCompleteAttachmentUploadResponse

Declaration

Objective-C

- (id)completeAttachmentUpload:
    (nonnull AWSConnectParticipantCompleteAttachmentUploadRequest *)request;

Swift

func completeAttachmentUpload(_ request: AWSConnectParticipantCompleteAttachmentUploadRequest) -> Any!

Parameters


                                request

A container for the necessary parameters to execute the CompleteAttachmentUpload service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectParticipantCompleteAttachmentUploadResponse. On failed execution, task.error may contain an NSError with AWSConnectParticipantErrorDomain domain and the following error code: AWSConnectParticipantErrorAccessDenied, AWSConnectParticipantErrorInternalServer, AWSConnectParticipantErrorThrottling, AWSConnectParticipantErrorValidation, AWSConnectParticipantErrorServiceQuotaExceeded, AWSConnectParticipantErrorConflict.


                    
                    
                    -completeAttachmentUpload:completionHandler:

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See

AWSConnectParticipantCompleteAttachmentUploadRequest

See

AWSConnectParticipantCompleteAttachmentUploadResponse

Declaration

Objective-C

- (void)completeAttachmentUpload:
            (nonnull AWSConnectParticipantCompleteAttachmentUploadRequest *)
                request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectParticipantCompleteAttachmentUploadResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

Swift

func completeAttachmentUpload(_ request: AWSConnectParticipantCompleteAttachmentUploadRequest) async throws -> AWSConnectParticipantCompleteAttachmentUploadResponse

Parameters


                                request

A container for the necessary parameters to execute the CompleteAttachmentUpload service method.


                                completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectParticipantErrorDomain domain and the following error code: AWSConnectParticipantErrorAccessDenied, AWSConnectParticipantErrorInternalServer, AWSConnectParticipantErrorThrottling, AWSConnectParticipantErrorValidation, AWSConnectParticipantErrorServiceQuotaExceeded, AWSConnectParticipantErrorConflict.


                    
                    
                    -createParticipantConnection:

Creates the participant’s connection.

ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until 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.

Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See

AWSConnectParticipantCreateParticipantConnectionRequest

See

AWSConnectParticipantCreateParticipantConnectionResponse

Declaration

Objective-C

- (id)createParticipantConnection:
    (nonnull AWSConnectParticipantCreateParticipantConnectionRequest *)request;

Swift

func createParticipantConnection(_ request: AWSConnectParticipantCreateParticipantConnectionRequest) -> Any!

Parameters


                                request

A container for the necessary parameters to execute the CreateParticipantConnection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectParticipantCreateParticipantConnectionResponse. On failed execution, task.error may contain an NSError with AWSConnectParticipantErrorDomain domain and the following error code: AWSConnectParticipantErrorAccessDenied, AWSConnectParticipantErrorInternalServer, AWSConnectParticipantErrorThrottling, AWSConnectParticipantErrorValidation.


                    
                    
                    -createParticipantConnection:completionHandler: