HYPPluginExtension

@protocol HYPPluginExtension <NSObject>

The HYPPluginExtension protocol provides the plugin with context about windows and containers that are available to it.

  • This method returns the window Hyperion is currently attached to.

    Declaration

    Objective-C

    - (id)attachedWindow;

    Swift

    func attachedWindow() -> Any!

    Return Value

    The current window Hyperion is attached to.

    Show on GitHub

  • This method returns the window that displays the Hyperion plugin drawer.

    Declaration

    Objective-C

    - (id)hypeWindow;

    Swift

    func hypeWindow() -> Any!

    Return Value

    The window that displays the Hyperion plugin drawer.

    Show on GitHub

  • This method returns the container that all of the snapshot plugins modules will use.

    Declaration

    Objective-C

    - (nonnull id<HYPSnapshotContainer>)snapshotContainer;

    Swift

    func snapshotContainer() -> HYPSnapshotContainer

    Return Value

    The container that HYPSnapshotPlugin ‘s will use to display.

    Show on GitHub

  • This method returns the container that all of the overlay plugins modules will use.

    Declaration

    Objective-C

    - (nonnull id<HYPOverlayContainer>)overlayContainer;

    Swift

    func overlayContainer() -> HYPOverlayContainer

    Return Value

    The container that HYPOverlayPlugin ‘s will use to display.

    Show on GitHub

  • This method will present a view controller modally over the Hyperion plugin drawer.

    Note: This is useful for plugins that display information that doesn’t fit into the snapshot or overlay category.

    Declaration

    Objective-C

    - (void)presentViewControllerOverDrawer:(id)controller animated:(BOOL)animated;

    Swift

    func presentViewControllerOverDrawer(_ controller: Any!, animated: Bool)

    Parameters

    controller

    The ViewController to present modally.
    animated

    Whether or not the presentation is animated.
    Show on GitHub