SCCaseInterface

@interface SCCaseInterface : NSObject

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].

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

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *caseListName;

    Swift

    var caseListName: String? { get set }

  • The name of the action used to create a case.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *caseCreateActionName;

    Swift

    var caseCreateActionName: String? { get set }

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    NSTimeInterval caseMetadataCacheRetentionTimeInterval;

    Swift

    var caseMetadataCacheRetentionTimeInterval: TimeInterval { 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: YES

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL remoteLoggingEnabled;

    Swift

    var remoteLoggingEnabled: Bool { get set }

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

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger caseUnreadCount;

    Swift

    var caseUnreadCount: Int { get }

  • Delete the case layout cache if it exists.

    Returns YES if the case layout cache has been deleted.

    Declaration

    Objective-C

    - (BOOL)deleteCaseLayoutCache;

    Swift

    func deleteCaseLayoutCache() -> Bool

CaseUI

  • 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.

    See

    -showCreateCasePublisher:completion:

    Declaration

    Objective-C

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

    Swift

    func setInterfaceVisible(_ interfaceVisible: Bool, animated: Bool, completion completionBlock: (() -> Void)? = nil)

    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.

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

    See

    -setInterfaceVisible:animated:completion:

    Declaration

    Objective-C

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

  • Shows the case publisher UI.

    See

    -showCreateCasePublisher:completion:

    Declaration

    Objective-C

    - (void)showCreateCasePublisher:(nonnull dispatch_block_t)completionBlock;

    Parameters

    completionBlock

    Optional block to invoke when the interface is presented.

  • Shows the case publisher UI.

    See

    -setInterfaceVisible:animated:completion:

    See

    SCServiceCloud.account

    Declaration

    Objective-C

    - (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.