HYPPlugin

@protocol HYPPlugin <NSObject>

The HYPPlugin protocol defines a mechanism for creating instances of plugins and providing metadata about a plugin.

@since v1.0

  • This method is called in order to create a new plugin instance.

    Declaration

    Objective-C

    + (nonnull id<HYPPluginModule>)createPluginModule:
    (id<HYPPluginExtension> _Nonnull)pluginExtension;

    Swift

    static func createPluginModule(_ pluginExtension: HYPPluginExtension) -> HYPPluginModuleProtocol

    Parameters

    pluginExtension

    Extra data that the plugin might need in order to function.

    Return Value

    A new plugin module instance the represents the HYPPlugin.

    Show on GitHub

  • This method is used to retrieve the plugin’s version.

    Declaration

    Objective-C

    + (nonnull NSString *)pluginVersion;

    Swift

    static func pluginVersion() -> String

    Return Value

    The semantic version for the plugin.

    Show on GitHub

  • This method is used to retrieve a view controller that represents a guide on how to use the plugin.

    Note: This view controller will be presented in a NavigationController.

    Declaration

    Objective-C

    + (id)createPluginGuideViewController;

    Swift

    optional static func createPluginGuideViewController() -> Any!

    Return Value

    A ViewController that guides the user on how to

    Show on GitHub

  • This method is used to retrieve an image that represents the plugin. This can be used so outside sources (like the HyperionExample app) can represent the plugin.

    Note: This is not the image used in the plugin list.

    Declaration

    Objective-C

    + (id)pluginGuideImage;

    Swift

    optional static func pluginGuideImage() -> Any!

    Return Value

    An image that represents the plugin.

    Show on GitHub

  • This method is used to retrieve a name that represents the plugin. This can be used so outside sources (like the HyperionExample app) can represent the plugin.

    Note: This is not the name used in the plugin list.

    Declaration

    Objective-C

    + (id)pluginGuideName;

    Swift

    optional static func pluginGuideName() -> Any!

    Return Value

    A name that represents the plugin.

    Show on GitHub