SCSChatConfiguration Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SCSChatConfiguration.h

Overview

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

Initialization

– initWithLiveAgentPod:orgId:deploymentId:buttonId:

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

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

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.

Declared In

SCSChatConfiguration.h

Deployment Configuration

  liveAgentPod

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

@property (nonatomic, strong, readonly) NSString *liveAgentPod

Declared In

SCSChatConfiguration.h

  organizationId

The Salesforce 15 character Organization ID.

@property (nonatomic, strong, readonly) NSString *organizationId

Declared In

SCSChatConfiguration.h

  deploymentId

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

@property (nonatomic, strong, readonly) NSString *deploymentId

Declared In

SCSChatConfiguration.h

  buttonId

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

@property (nonatomic, strong, readonly) NSString *buttonId

Declared In

SCSChatConfiguration.h

Session Behavior

  prechatFields

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

@property (nonatomic, readonly, strong) NSMutableArray<SCSPrechatObject*> *prechatFields

Declared In

SCSChatConfiguration.h

  prechatEntities

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

@property (nonatomic, readonly, strong) NSMutableArray<SCSPrechatEntity*> *prechatEntities

Declared In

SCSChatConfiguration.h

  visitorName

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

@property (nonatomic, copy) NSString *visitorName

Discussion

Defaults to Visitor.

Declared In

SCSChatConfiguration.h

  )

Defines how the Live Agent Chat session is presented when it starts.

@property (nonatomic, assign) SCSChatPresentationStyle presentationStyle NS_SWIFT_UNAVAILABLE ( "Use allowMinimization, defaultToMinimized, and fullscreenPrechat instead" __deprecated_msg ( "Use allowMinimization, defaultToMinimized, and fullscreenPrechat instead" )

Discussion

Defaults to SCSChatPresentationStyleNonBlocking.

Declared In

SCSChatConfiguration.h

  queueUpdatesEnabled

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

@property (nonatomic, assign) BOOL queueUpdatesEnabled

Discussion

Defaults to YES.

Declared In

SCSChatConfiguration.h

  remoteLoggingEnabled

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.

@property (nonatomic) BOOL remoteLoggingEnabled

Discussion

Default to YES.

Declared In

SCSChatConfiguration.h

User Interface Behavior

  allowMinimization

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

@property (nonatomic, assign) BOOL allowMinimization

Discussion

Defaults to YES.

Declared In

SCSChatConfiguration.h

  defaultToMinimized

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

@property (nonatomic, assign) BOOL defaultToMinimized

Discussion

Defaults to YES.

Declared In

SCSChatConfiguration.h

  fullscreenPrechat

Defines whether the prechat screen is presented as a modal or fullscreen view controller.

@property (nonatomic, assign) BOOL fullscreenPrechat

Discussion

Defaults to NO.

Declared In

SCSChatConfiguration.h