SCServiceCloud Class Reference
Inherits from | NSObject |
---|---|
Declared in | SCServiceCloud.h |
Overview
Shared singleton class used as the primary access point for the Service SDK.
Use the [SCServiceCloud sharedInstance]
class method to access the singleton
for this class.
You can access each of the SDK features with properties on this singleton:
SCServiceCloud.
knowledge,
SCServiceCloud.
cases,
SCServiceCloud.
chat,
SCServiceCloud.
sos.
Configure the SDK using the SCServiceCloud.
serviceConfiguration property.
Customize the appearance of the interface using the
SCServiceCloud.
appearanceConfiguration property.
Interface for accessing the SOSSessionManager
instance via the Service Common singleton.
Interface for accessing the SCSChat instance via the Service Common singleton manager.
Other Methods
+ sharedInstance
Returns the shared service cloud manager for this process.
+ (instancetype)sharedInstance
Return Value
Initialized shared instace.
Declared In
SCServiceCloud.h
primaryWindow
Identifies the primary window where view controllers should be placed when presented.
@property (null_resettable, nonatomic, strong) UIWindow *primaryWindow
Discussion
This value is automatically determined under most circumstances, but in the
event that a custom value needs to be set, the primaryWindow
property can
be set to a specific window that should be used.
Declared In
SCServiceCloud.h
delegate
The delegate for the service interface manager.
@property (nonatomic, weak, nullable) NSObject<SCServiceCloudDelegate> *delegate
Declared In
SCServiceCloud.h
interfaceStyle
The appearance style to use in presented views and view controllers.
@property (nonatomic, copy) NSString *interfaceStyle
Discussion
The default value for this is SCInterfaceStyleDefault
. If this value is set
after the interface has already been presented, it results in the service
interface being dismissed.
Warning: We recommend that you only assign this property once in the lifetime of an application. Changing interface styles at runtime may have unpredictable results, and the behavior is undefined.
Declared In
SCServiceCloud.h
appearanceConfiguration
Sets the appearance configuration for the service interface. If not specified, this value falls back to default values.
@property (nonatomic, strong) SCAppearanceConfiguration *appearanceConfiguration
Declared In
SCServiceCloud.h
serviceConfiguration
Configuration object used to define the self-service parameters used to enable with Cases and/or Knowledge features.
@property (nonatomic, strong) SCSServiceConfiguration *serviceConfiguration
Declared In
SCServiceCloud.h
account
Mobile SDK user account instance to use for interactions with Salesforce.
@property (null_resettable, nonatomic, strong) SFUserAccount *account
Discussion
This property is automatically reset to a guest user account instance when
nil
is assigned.
Declared In
SCServiceCloud.h
– setAccount:completion:
Sets the account property asynchronously, allowing authentication errors to be received and processed by the caller.
- (void)setAccount:(SFUserAccount *)account completion:(nullable void ( ^ ) ( NSError *_Nullable ))completion
Parameters
account |
User account object to set. |
---|---|
completion |
Completion block invoked when the account information has been validated. |
Discussion
Note: This setter requires a nonnull account object to be assigned.
Declared In
SCServiceCloud.h
Notifications Methods
– notificationFromRemoteNotificationDictionary:
Returns a concrete subclass of SCSNotification
from a remote notification
dictionary.
- (nullable SCSNotification *)notificationFromRemoteNotificationDictionary:(NSDictionary *)userInfo
Parameters
userInfo |
The remote notification dictionary. |
---|
Discussion
Returns nil
if the notification cannot be handled by the SDK.
Use showInterfaceForNotification:
to show the view associated with this
notification.
Declared In
SCServiceCloud.h
– showInterfaceForNotification:
Shows the appropriate view related to the notification that is passed to this method.
- (BOOL)showInterfaceForNotification:(SCSNotification *)notification
Parameters
notification |
The notification that determines what interface to show. |
---|
Discussion
Use notificationFromRemoteNotificationDictionary:
to convert an
NSDictionary
into an SCSNotification
object.
Declared In
SCServiceCloud.h
CaseManagement Methods
cases
The singleton instance for Case Management.
@property (nonatomic, strong, readonly) SCCaseInterface *cases
Declared In
SCServiceCloud+CaseUI.h
SOS Methods
sos
The singleton instance for SOS.
@property (nonatomic, strong, readonly) SOSSessionManager *sos
Declared In
SCServiceCloud+SOSSessionManager.h
LiveAgentChat Methods
chat
The singleton instance for Live Agent Chat.
@property (nonatomic, strong, readonly) SCSChat *chat
Declared In
SCServiceCloud+SCSChat.h
Knowledge Methods
knowledge
The singleton instance for Knowledge.
@property (nonatomic, strong, readonly) SCKnowledgeInterface *knowledge
Declared In
SCServiceCloud+KnowledgeUI.h
ActionManager Methods
actions
Access point for interacting with the floating action bar.
@property (nonatomic, strong, readonly) SCSActionManager *actions
Declared In
SCServiceCloud.h