SCSChatConfiguration

@interface SCSChatConfiguration : NSObject <NSCopying>

A SCSChatConfiguration object contains configuration information for a Live Agent Chat session.

Initialization

  • Instantiates an SCSChatConfiguration object for use with -[SCSChat startSessionWithConfiguration:].

    Declaration

    Objective-C

    - (instancetype)initWithLiveAgentPod:(NSString *)liveAgentPod
                               orgId:(NSString *)orgId
                        deploymentId:(NSString *)deploymentId
                            buttonId:(NSString *)buttonId;

    Swift

    init!(liveAgentPod: String!, orgId: String!, deploymentId: String!, buttonId: String!)

    Parameters

    liveAgentPod

    The hostname for the LiveAgent endpoints that your organization has been assigned.
    orgId

    The Salesforce 15 character Organization ID.
    deploymentId

    The unique ID for the deployment that this client will be configured to use.
    buttonId

    The unique ID for the chat configuration that this client will use.

    Return Value

    The SCSChatConfiguration instance.

Deployment Configuration

Session Behavior

  • The eventlist which describes a set of special URLs which will trigger an event the application can listen to to allow custom app interactions through the chat feed.

    Events will be fired when a user presses the associated button on the feed when we detect a registered URL.

    Declaration

    Objective-C

    @property (nonatomic, copy) SCSAppEventList *eventList;

    Swift

    @NSCopying var eventList: SCSAppEventList! { get set }

  • An array of SCSPrechatObject objects defining the custom information this session will provide.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<SCSPrechatObject *> *prechatFields;

    Swift

    var prechatFields: [SCSPrechatObject]! { get set }

  • An array of SCSPrechatEntity objects defining the mappings of custom information from this session to salesforce objects.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<SCSPrechatEntity *> *prechatEntities;

    Swift

    var prechatEntities: [SCSPrechatEntity]! { get set }

  • Name of the chat visitor for Service Cloud agent & console to consume.

    Defaults to Visitor.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *visitorName;

    Swift

    var visitorName: String! { get set }

  • Determines whether the framework receives and displays updates about the session queue position.

    Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL queueUpdatesEnabled;

    Swift

    var queueUpdatesEnabled: Bool { get set }

  • Specifies the way queue updates are conveyed to the user while waiting in a queue.

    Defaults to SCSChatConfigurationQueueStylePosition.

    See

    SCSChatConfigurationQueueStyle

    Declaration

    Objective-C

    @property (nonatomic) SCSChatConfigurationQueueStyle queueStyle;

    Swift

    var queueStyle: SCSChatConfigurationQueueStyle { get set }

  • Determines whether session logs are sent for collection. Logs sent remotely do not collect personal information. Unique IDs are created for tying logs to sessions, and those IDs cannot be correlated back to specific users.

    Default to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL remoteLoggingEnabled;

    Swift

    var remoteLoggingEnabled: Bool { get set }

  • Determines whether the session will use UIApplication’s beginBackgroundTask API to allow for extended background execution to allow for reduced session timeouts.

    Default to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowBackgroundExecution;

    Swift

    var allowBackgroundExecution: Bool { get set }

  • Determines whether the session will use UserNotifications to post local notifications on selected chat events. Requires allowBackgroundExecution to be set to YES.

    Default to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowBackgroundNotifications;

    Swift

    var allowBackgroundNotifications: Bool { get set }

User Interface Behavior

  • Defines whether the user is presented with the ability to minimize the user interface.

    Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowMinimization;

    Swift

    var allowMinimization: Bool { get set }

  • Defines whether the user interface is presented in minimized mode following prechat submission.

    Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL defaultToMinimized;

    Swift

    var defaultToMinimized: Bool { get set }

  • Defines whether the user is shown URL previews when the agent types a URL in the chat feed.

    Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowURLPreview;

    Swift

    var allowURLPreview: Bool { get set }

  • The minimum estimated wait time value (in seconds) to display to the user. Only applicable when queueStyle is set to SCSChatConfigurationQueueStyleEstimatedWaitTime.

    Default: 60.0

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval minimumEstimatedWaitTime;

    Swift

    var minimumEstimatedWaitTime: TimeInterval { get set }

  • The maximum estimated wait time value (in seconds) to display to the user. Only applicable when queueStyle is set to SCSChatConfigurationQueueStyleEstimatedWaitTime.

    Default: 600.0

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval maximumEstimatedWaitTime;

    Swift

    var maximumEstimatedWaitTime: TimeInterval { get set }