SherpaViewController

open class SherpaViewController : UIViewController, UINavigationControllerDelegate, ListViewControllerDelegate

Undocumented

Deep-linking

  • Key matching an article to be displayed.

    Declaration

    Swift

    open var articleKey: String?

  • Determine if an article matching the given key is available.

    Declaration

    Swift

    open func contains(articleForKey key: String) -> Bool

    Parameters

    key

    String matching an article within the document.

    Return Value

    Flag indicating that an article matching the given key exists.

  • Have an article matching the given key pushed into the navigation hierarchy, if possible.

    Declaration

    Swift

    open func open(articleForKey key: String, animated: Bool)

    Parameters

    key

    String matching an article within the document.
    animated

    Flag indicating whether the view controller transition should be animated.

  • Opens a screen for composing an email to the address from the document at the given fileURL.

    Declaration

    Swift

    public static func openEmail(from fileURL: URL, presentingFrom presentingViewController: UIViewController, animated: Bool)

    Parameters

    fileURL

    The file URL for the document to retrieve the Twitter account details from.
    presentingViewController

    The view controller to present from.
    animated

    Flag indicating whether the view controller transition should be animated.

  • Opens the Twitter handle from the document at the given fileURL.

    Declaration

    Swift

    public static func openTwitter(from fileURL: URL, presentingFrom presentingViewController: UIViewController, animated: Bool)

    Parameters

    fileURL

    The file URL for the document to retrieve the Twitter account details from.
    presentingViewController

    The view controller to present from.
    animated

    Flag indicating whether the view controller transition should be animated.

Allowing feedback

  • Email address for receiving feedback.

    Declaration

    Swift

    @available(*, deprecated)
open var feedbackEmail: String? { get set }

  • Twitter account handle for receiving feedback.

    Declaration

    Swift

    @available(*, deprecated)
open var feedbackTwitter: String? { get set }

Customising appearance

  • Tint color used for indicating links.

    Declaration

    Swift

    open var tintColor: UIColor! { get set }

  • Background color for article pages.

    Declaration

    Swift

    open var articleBackgroundColor: UIColor! { get set }

  • Text color for article pages.

    Declaration

    Swift

    open var articleTextColor: UIColor! { get set }

  • Text color for article pages.

    Declaration

    Swift

    open var articleCSS: String? { get set }

  • Register the class used to display article rows in the table view.

    Declaration

    Swift

    @objc(registerTableViewCellClassForArticleRows:)
open func registerTableViewCellClass(forArticleRows cellClass: UITableViewCell.Type)

    Parameters

    cellClass

    The cell class to use for displaying article rows.

  • Register the class used to display feedback rows in the table view.

    Declaration

    Swift

    @objc(registerTableViewCellClassForFeedbackRows:)
open func registerTableViewCellClass(forFeedbackRows cellClass: UITableViewCell.Type)

    Parameters

    cellClass

    The cell class to use for displaying feedback rows.

Instance life cycle

  • Creates a SherpaViewController instance for the file at the given file URL.

    Declaration

    Swift

    public init(fileAtURL fileURL: URL)

  • Undocumented

    Declaration

    Swift

    public required init?(coder aDecoder: NSCoder)

View controller

  • Undocumented

    Declaration

    Swift

    open override func viewDidLoad()

  • Undocumented

    Declaration

    Swift

    open override var navigationItem: UINavigationItem { get }

  • Undocumented

    Declaration

    Swift

    open override var childForStatusBarHidden: UIViewController? { get }

  • Undocumented

    Declaration

    Swift

    open override var childForStatusBarStyle: UIViewController? { get }

Navigation controller delegate

  • Undocumented

    Declaration

    Swift

    open func navigationController(_ navigationController: UINavigationController, willShow viewController: UIViewController, animated: Bool)

Utilities

  • Undocumented

    Declaration

    Swift

    @objc
open func sherpa_dismiss()