HYPPluginModule

@protocol HYPPluginModule

HYPPluginModule protocol represents an instance of a plugin.

  • Creates a new plugin module with the provided extension.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExtension:
        (nonnull id<HYPPluginExtension>)extension;

    Parameters

    extension

    The extension the plugin module should be created with.

  • Represents if the plugin is currently active.

    Declaration

    Objective-C

    @property (nonatomic, readonly) int active;
  • The extension that the plugin module was intialized with.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) id<HYPPluginExtension> extension;
  • The title that should display for the plugin menu Item.

    Declaration

    Objective-C

    - (id)pluginMenuItemTitle;

    Return Value

    The title that should display for the plugin menu Item.

  • The image that should display for the plugin menu Item.

    Declaration

    Objective-C

    - (id)pluginMenuItemImage;

    Return Value

    The image that should display for the plugin menu Item.

  • Determines whether the drawer should hide when the plugin becomes active/inactive.

    Declaration

    Objective-C

    - (id)shouldHideDrawerOnSelection;

    Return Value

    Yes if the drawer should hide when the plugin becomes active/inactive.