SCKnowledgeInterface Class Reference

Inherits from NSObject
Declared in SCKnowledgeInterface.h

Overview

The SCKnowledgeInterface class is the main interface to the Knowledge SDK. Use this class to configure and customize the Knowledge interface.

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

  )

Indicates whether the Knowledge interface is enabled.

@property (nonatomic, assign, getter=isEnabled) BOOL enabled __deprecated_msg ( "This property is no longer required and will be removed in a future release" )

Declared In

SCKnowledgeInterface.h

  interfaceVisible

Indicates whether the Knowledge 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

SCKnowledgeInterface.h

  delegate

The delegate for the Knowledge interface.

@property (nullable, nonatomic, weak) NSObject<SCKnowledgeInterfaceDelegate> *delegate

Declared In

SCKnowledgeInterface.h

– setInterfaceVisible:animated:completion:

Controls the visibility of the Knowledge interface, with an optional animation.

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

Parameters

interfaceVisible

YES to make the interface visible; NO to hide the interface.

animated

YES to animate; NO to perform no animation.

completionBlock

Optional block to invoke when the interface change has completed.

Declared In

SCKnowledgeInterface.h

– showArticle:animated:completion:

Presents the given article stand-alone within the knowledge interface.

- (UINavigationController<SCSMinimizable> *)showArticle:(SCSArticle *)article animated:(BOOL)animated completion:(nullable dispatch_block_t)completionBlock

Parameters

article

The article to present.

animated

Indicates if the presentation should be animated.

completionBlock

Completion block to trigger when the controller is presented.

Return Value

Minimizable navigation controller containing the presented article.

Discussion

When presented this way, it is minimizable on its own, independent of other elements of the support experience. The resulting navigation controller is returned, allowing other interface elements to be pushed onto it. For example, after presenting an article in this way, other SCSArticleViewController instances can be pushed on as needed.

Declared In

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

SCKnowledgeInterface.h