ACSCallClient Class

  • Article

Declaration

@interface ACSCallClient : NSObject;

Description

This is the main class representing the entrypoint for the Calling SDK.

Methods

init

Creates a new instance with a default configuration

-(instancetype)init;

dispose

Releases all the resources held by CallClient. CallClient should be destroyed/nullified after dispose.

-(void)dispose;

init

Creates a new instance with CallClientOptions.

-(instancetype)init:(ACSCallClientOptions *)options;

Parameters

  • options -

createCallAgent

Creates an instance of call agent.

-(void)createCallAgent:(CommunicationTokenCredential* _Nonnull) userCredential
 withCompletionHandler:(void (^ _Nonnull)(ACSCallAgent* _Nullable clientAgent,
                                          NSError * _Nullable error))completionHandler;

Parameters

  • userCredential - CommunicationUserCredential for authentication.
  • clientAgent - Call agent.
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

createCallAgentWithOptions

Creates an instance of call agent with options.

-(void)createCallAgentWithOptions:(CommunicationTokenCredential* _Nonnull) userCredential
                 callAgentOptions:(ACSCallAgentOptions* _Nullable) callAgentOptions
            withCompletionHandler:(void (^ _Nonnull)(ACSCallAgent* _Nullable clientAgent,
                                                     NSError* _Nullable error))completionHandler;

Parameters

  • userCredential - CommunicationUserCredential for authentication.
  • callAgentOptions - configurations to be passed with call agent.
  • clientAgent - Call agent.
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

reportIncomingCall

Sends notification of incoming call.

+(void)reportIncomingCall:(ACSPushNotificationInfo* _Nonnull)payload
                    callKitOptions:(ACSCallKitOptions* _Nonnull) callKitOptions
             withCompletionHandler:(void (^ _Nonnull)(NSError* _Nullable error))completionHandler;

Parameters

  • payload - Payload of push notification.
  • callKitOptions - Options of callKit.
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

getDeviceManagerWithCompletionHandler

-(void)getDeviceManagerWithCompletionHandler:(void (^ _Nonnull)(ACSDeviceManager* _Nullable value,
                                                                NSError* _Nullable error))completionHandler;

Parameters

  • value - Value of instance of device manager.
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

Properties

debugInfo

Retrieves the DebugInfo class, which is an interface to Debugging/Support helpers such as retrieving files for support

@property (retain, nonnull, readonly) ACSCallDebugInfo * debugInfo;

communicationCredential

Communication token.

@property (retain, nonnull) CommunicationTokenCredential* communicationCredential;