HBAboutListController

Objective-C

@interface HBAboutListController : HBListController

Swift

class HBAboutListController : HBListController

The HBAboutListController class in CepheiPrefs provides a list controller with functions that would typically be used on an “about” page. It includes two class methods you can override to provide a developer website and donation URL, and a class method to provide an email address so the user can send the developer an email right from the tweak’s settings.

There is a sample of an HBAboutListController implemented in the Cephei demo preferences. See the Cephei readme for details.

Example Usage

<dict>
    <key>cell</key>
    <string>PSLinkCell</string>
    <key>cellClass</key>
    <string>HBLinkTableCell</string>
    <key>label</key>
    <string>Visit Website</string>
    <key>url</key>
    <string>https://hashbang.productions/</string>
</dict>
<dict>
    <key>cell</key>
    <string>PSGroupCell</string>
    <key>label</key>
    <string>Experiencing issues?</string>
</dict>
<dict>
    <key>action</key>
    <string>hb_sendSupportEmail</string>
    <key>cell</key>
    <string>PSLinkCell</string>
    <key>label</key>
    <string>Email Support</string>
</dict>
<dict>
    <key>cell</key>
    <string>PSGroupCell</string>
    <key>footerText</key>
    <string>If you like this tweak, please consider a donation.</string>
</dict>
<dict>
    <key>cell</key>
    <string>PSLinkCell</string>
    <key>cellClass</key>
    <string>HBLinkTableCell</string>
    <key>label</key>
    <string>Donate</string>
    <key>url</key>
    <string>https://hashbang.productions/donate/</string>
</dict>

Constants

  • Deprecated

    Use an HBLinkTableCell instead.

    The website URL to open when tapping the “visit website” cell. Override this method to return your own URL.

    Deprecated. It is encouraged to use an HBLinkTableCell instead.

    Declaration

    Objective-C

    + (nonnull NSURL *)hb_websiteURL;

    Swift

    class func hb_websiteURL() -> URL

    Return Value

    By default, https://hashbang.productions/.

  • Deprecated

    Use an HBLinkTableCell instead.

    The website URL to open when tapping the “donate” cell. Override this method to return your own URL.

    Deprecated. It is encouraged to use an HBLinkTableCell instead.

    Declaration

    Objective-C

    + (nonnull NSURL *)hb_donateURL;

    Swift

    class func hb_donateURL() -> URL

    Return Value

    By default, https://hashbang.productions/donate/.

  • The email address to use in the support email composer form. Override this method to return an email address.

    If this method returns nil, the package’s author email address is used.

    Declaration

    Objective-C

    + (nullable NSString *)hb_supportEmailAddress;

    Swift

    class func hb_supportEmailAddress() -> String?

    Return Value

    By default, nil.

  • Deprecated

    TechSupport is no longer supported.

    The instructions to provide to the TechSupport framework, in addition to the default ones provided by Cephei. For details and examples of support instructions, refer to the TechSupport project’s GitHub repo: https://github.com/ashikase/TechSupport/tree/master/Demo

    See

    HBSupportController

    Declaration

    Objective-C

    + (nullable NSArray *)hb_supportInstructions;

    Swift

    class func hb_supportInstructions() -> [Any]?

    Return Value

    By default, nil.

Preference Specifier Actions

  • Deprecated

    Use an HBLinkTableCell instead.

    Opens the user’s browser to the URL specified by hb_websiteURL.

    Deprecated. Use an HBLinkTableCell instead.

    Declaration

    Objective-C

    - (void)hb_openWebsite;

    Swift

    func hb_openWebsite()
  • Deprecated

    Use an HBLinkTableCell instead.

    Opens the user’s browser to the URL specified by hb_donateURL.

    Deprecated. Use an HBLinkTableCell instead.

    Declaration

    Objective-C

    - (void)hb_openDonate;

    Swift

    func hb_openDonate()
  • Displays a support composer form.

    The hb_supportEmailAddress and hb_supportInstructions methods are used to provide the appropriate parameters to HBSupportController.

    See

    HBSupportController

    Declaration

    Objective-C

    - (void)hb_sendSupportEmail;

    Swift

    func hb_sendSupportEmail()