BCAccount Class Reference
A set of BoldChat account settings identified by an access key. More...
#import <BCAccount.h>
Instance Methods | |
| (id) | - initWithAccessKey: |
| The constructor. More... | |
| (id< BCCancelable >) | - createChatSessionWithDelegate:language: |
| Initiates the chat session creation process. If pre chat form is enabled it will return pre chat information, if pre chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions. More... | |
| (id< BCCancelable >) | - createChatSessionWithDelegate:language:visitorId:skipPreChat:externalParams: |
| Initiates the chat session creation process. If pre chat form is enabled it will return pre chat information, if pre chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions. More... | |
| (id< BCCancelable >) | - createSecuredChatSessionWithDelegate:language:securedParams: |
| Initiates the chat session creation process. If pre-chat form is enabled it will return pre-chat information, if pre-chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions. More... | |
| (id< BCCancelable >) | - createSecuredChatSessionWithDelegate:language:visitorId:skipPreChat:externalParams:securedParams: |
| Initiates the chat session creation process. If pre-chat form is enabled it will return pre-chat information, if pre-chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions. More... | |
| (id< BCCancelable >) | - getChatAvailabilityWithDelegate: |
| Retrieves the availability of the chat service. This can be used to check if chat will be available before showing the option for live chat. This can be called at any time without an existing chat session. Results will be cached for 1 minute. More... | |
| (id< BCCancelable >) | - getChatAvailabilityWithDelegate:visitorId: |
| Retrieves the availability of the chat service. This can be used to check if chat will be available before showing the option for live chat. This can be called at any time without an existing chat session. Results will be cached for 1 minute. More... | |
| (NSString *) | - versionString |
| The SDK version string. More... | |
Class Methods | |
| (id) | + accountWithAccessKey: |
| The static constructor. More... | |
Properties | |
| NSString * | accessKey |
| The access key for the SDK. More... | |
Detailed Description
A set of BoldChat account settings identified by an access key.
This class is the starting point for access the BoldChat SDK. To begin an instance of this class should be created with BCAccount::accountWithAccessKey: or BCAccount::initWithAccessKey:. This class instantiates the chat availability checkers and the chat sessions.
The chat availability checkers check if the chat is available. These are created by getChatAvailabilityWithDelegate: and getChatAvailabilityWithDelegate:visitorId: calls.
The chat sessions are for performing the actual chat session. They are created by createChatSessionWithDelegate:language: and BCAccount::createChatSessionWithDelegate:language:visitorId:skipPreChat:externalParams:.
- Since
- Version 1.0
Method Documentation
| + (id) accountWithAccessKey: | (NSString *) | accessKey |
The static constructor.
- Parameters
-
accessKey Access key. Mandatory parameter.
- Returns
- A BCAccount instance.
- Since
- Version 1.0
| - (id<BCCancelable>) createChatSessionWithDelegate: | (id< BCCreateChatSessionDelegate >) | delegate | |
| language: | (NSString *) | language | |
Initiates the chat session creation process. If pre chat form is enabled it will return pre chat information, if pre chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions.
- Parameters
-
delegate Delegate The delegate that will be called to receive the data after the SDK call is completed. language Language string to initialize. It must be an ISO 639-1 language code optionally followed by a dash then an ISO 3166-1 country code (en-US).If not set, the application's current language is going to be set.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.0
| - (id<BCCancelable>) createChatSessionWithDelegate: | (id< BCCreateChatSessionDelegate >) | delegate | |
| language: | (NSString *) | language | |
| visitorId: | (NSString *) | visitorId | |
| skipPreChat: | (BOOL) | skipPreChat | |
| externalParams: | (NSDictionary *) | externalParams | |
Initiates the chat session creation process. If pre chat form is enabled it will return pre chat information, if pre chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions.
- Parameters
-
delegate Delegate The delegate that will be called to receive the data after the SDK call is completed. language Language string to initialize. It must be an ISO 639-1 language code optionally followed by a dash then an ISO 3166-1 country code (en-US). If not set, the application's current language is going to be set. visitorId The id If the application has previously called createChatSession and a visitorId was returned re-use that id for all subsequent calls for each unique user. If this is the first time the application has used createChat this parameter should be left empty and a new VisitorID will be generated and returned by the server. skipPreChat If there is pre chat set for the chat it can be skipped with sending the answers in the data. externalParams The answers for the skipped pre chat and external parameters.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.0
| - (id<BCCancelable>) createSecuredChatSessionWithDelegate: | (id< BCCreateChatSessionDelegate >) | delegate | |
| language: | (NSString *) | language | |
| securedParams: | (NSString *) | securedParams | |
Initiates the chat session creation process. If pre-chat form is enabled it will return pre-chat information, if pre-chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions.
- Parameters
-
delegate Delegate The delegate that will be called to receive the data after the SDK call is completed. language Language string to initialise. It must be an ISO 639-1 language code optionally followed by a dash then an ISO 3166-1 country code (en-US).If not set, the application's current language is going to be set. securedParams An encrypted list of parameters that validate the caller of the API.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.1
| - (id<BCCancelable>) createSecuredChatSessionWithDelegate: | (id< BCCreateChatSessionDelegate >) | delegate | |
| language: | (NSString *) | language | |
| visitorId: | (NSString *) | visitorId | |
| skipPreChat: | (BOOL) | skipPreChat | |
| externalParams: | (NSDictionary *) | externalParams | |
| securedParams: | (NSString *) | securedParams | |
Initiates the chat session creation process. If pre-chat form is enabled it will return pre-chat information, if pre-chat is not enabled it will return information about connecting the chat. If chat is unavailable then unavailable information will be returned instead. Calling this method is required for all chat sessions.
- Parameters
-
delegate Delegate The delegate that will be called to receive the data after the SDK call is completed. language Language string to initialise. It must be an ISO 639-1 language code optionally followed by a dash then an ISO 3166-1 country code (en-US).If not set, the application's current language is going to be set. visitorId The id If the application has previously called createChatSession and a visitorId was returned re-use that id for all subsequent calls for each unique user. If this is the first time the application has used createChat this parameter should be left empty and a new VisitorID will be generated and returned by the server. skipPreChat If there is pre-chat set for the chat it can be skipped with sending the answers in the data externalParams The answers for the skipped pre chat and external parameters. securedParams An encrypted list of parameters that validate the caller of the API.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.1
| - (id<BCCancelable>) getChatAvailabilityWithDelegate: | (id< BCChatAvailabilityDelegate >) | delegate |
Retrieves the availability of the chat service. This can be used to check if chat will be available before showing the option for live chat. This can be called at any time without an existing chat session. Results will be cached for 1 minute.
- Parameters
-
delegate The delegate that will be called with the chat availability.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.0
| - (id<BCCancelable>) getChatAvailabilityWithDelegate: | (id< BCChatAvailabilityDelegate >) | delegate | |
| visitorId: | (NSString *) | visitorId | |
Retrieves the availability of the chat service. This can be used to check if chat will be available before showing the option for live chat. This can be called at any time without an existing chat session. Results will be cached for 1 minute.
- Parameters
-
delegate The delegate that will be called with the chat availability. visitorId The id of a visitor that used the chat previously. It can be nil.
- Returns
- An object that implements BCCancelable protocol to be able to cancel the request.
- Since
- Version 1.0
| - (id) initWithAccessKey: | (NSString *) | accessKey |
The constructor.
- Parameters
-
accessKey Access key. Mandatory parameter.
- Returns
- A BCAccount instance.
- Since
- Version 1.0
| - (NSString *) versionString |
The SDK version string.
- Returns
- Version string.
- Since
- Version 1.0
Property Documentation
|
readnonatomiccopy |
The access key for the SDK.
- Since
- Version 1.0
The documentation for this class was generated from the following file: