HyperionManager

@interface HyperionManager : NSObject

HyperionManager is the interaction point between Hyperion and the app it’s integrated in.

Note: Hyperion handles embedding itself on it’s own, so using HyperionManager is not required.

  • The HyperionManager singleton.

    Note: This should be the only way used to retrieve an instance of HyperionManager.

    Declaration

    Objective-C

    + (HyperionManager *)sharedInstance;

    Swift

    class func sharedInstance() -> HyperionManager!
    Show on GitHub

  • Attaches Hyperion to the provided window.

    Declaration

    Objective-C

    - (void)attachToWindow:(id)window;

    Swift

    func attach(toWindow window: Any!)

    Parameters

    window

    The window to attach Hyperion to.
    Show on GitHub

  • Toggles Hyperion’s plugin drawer.

    Declaration

    Objective-C

    - (void)togglePluginDrawer;

    Swift

    func togglePluginDrawer()
    Show on GitHub

  • Provides a list of plugin classes.

    Declaration

    Objective-C

    - (NSArray<Class<HYPPlugin>> *)retrievePluginClasses;

    Swift

    func retrievePluginClasses() -> Any!

    Return Value

    A list of plugin classes.

    Show on GitHub

  • Provides a cached list of plugin modules.

    Declaration

    Objective-C

    - (NSArray<id<HYPPluginModule>> *)retrievePluginModules;

    Swift

    func retrievePluginModules() -> Any!

    Return Value

    A cached list of plugin modules.

    Show on GitHub

  • Force refreshes the plugin modules.

    Declaration

    Objective-C

    - (NSArray<id<HYPPluginModule>> *)forceRefreshPluginModules;

    Swift

    func forceRefreshPluginModules() -> Any!

    Return Value

    The latest available plugin modules.

    Show on GitHub

  • A bitmask of gestures that can be used to activate Hyperion.

    Declaration

    Objective-C

    @property (readonly, nonatomic) HYPActivationGestureOptions activationGestures;

    Swift

    var activationGestures: Int32 { get }
    Show on GitHub