SCCaseInterface Class Reference

Inherits from NSObject
Declared in SCCaseInterface.h

Overview

The SCCaseInterface class is the main interface to the Case Management SDK. Use this class to configure and customize the Case Management interface.

To get an instance of this class, use the SCServiceCloud.cases property on [SCServiceCloud sharedInstance].

Other Methods

  caseListName

The Salesforce unique name of the case list to be displayed.

@property (nonatomic, copy) NSString *caseListName

Declared In

SCCaseInterface.h

  caseCreateActionName

The name of the action used to create a case.

@property (nonatomic, copy) NSString *caseCreateActionName

Declared In

SCCaseInterface.h

  )

The duration (specified in seconds) after which the case metadata is deleted. The default value is 24 hours.

@property (nonatomic, assign) NSTimeInterval caseMetadataCacheRetentionTimeInterval __deprecated_msg ( "This property is no longer required and will be removed in a future release" )

Declared In

SCCaseInterface.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: YES

Declared In

SCCaseInterface.h

  caseUnreadCount

The count of the unread cases in the case list. This count will be accurate when the case list has been opened.

@property (nonatomic, readonly) NSInteger caseUnreadCount

Declared In

SCCaseInterface.h

– deleteCaseLayoutCache

Delete the case layout cache if it exists.

- (BOOL)deleteCaseLayoutCache

Discussion

Returns YES if the case layout cache has been deleted.

Declared In

SCCaseInterface.h

CaseUI Methods

– setInterfaceVisible:animated:completion:

Controls the visibility of the case publisher interface, with an optional animation. This method shows the case publisher UI for guest users and shows the case list UI for authenticated users.

- (void)setInterfaceVisible:(BOOL)interfaceVisible animated:(BOOL)animated completion:(nullable dispatch_block_t)completionBlock

Parameters

interfaceVisible

YES to make the appearance visible, otherwise it will be hidden.

animated

YES to animate, otherwise NO.

completionBlock

Optional block to invoke when the interface change is completed.

Declared In

SCCaseInterface+CaseUI.h

  interfaceVisible

Indicates whether or not the case publisher interface is currently visible. Setting this value will present or dismiss the interface in an unanimated fashion.

@property (nonatomic, assign, getter=isInterfaceVisible) BOOL interfaceVisible

Declared In

SCCaseInterface+CaseUI.h

– showCreateCasePublisher:

Shows the case publisher UI.

- (void)showCreateCasePublisher:(dispatch_block_t)completionBlock

Parameters

completionBlock

Optional block to invoke when the interface is presented.

Declared In

SCCaseInterface+CaseUI.h

– showCreateCasePublisher:completion:

Shows the case publisher UI.

- (void)showCreateCasePublisher:(BOOL)animated completion:(nullable dispatch_block_t)completionBlock

Parameters

animated

YES to animate, otherwise NO.

completionBlock

Optional block to invoke when the interface is presented.

See Also

  • SCServiceCloud.account

Declared In

SCCaseInterface+CaseUI.h