Protocols

The following protocols are available globally.

  • The HYPSnapshotContainer provides a mechanism of displaying custom UI over a Snapshot of the current app. This allows the user to zoom on the app and inspect tiny details, but also prevents the user from interacting with the app. The HYPSnapshotContainer holds the HYPSnapshotPluginViewProvider’s view when a snapshot plugin becomes active. It also provides convenience methods for presenting common UI across the Snanshot plugin platform.

    See more

    Declaration

    Objective-C

    @protocol HYPSnapshotContainer <NSObject>

    Swift

    protocol HYPSnapshotContainer : NSObjectProtocol
    Show on GitHub

  • The HYPOverlayContainer provides a mechanism for displaying custom UI over an app while still allowing the user to interact with it. The HYPOverlayContainer holds the HYPOverlayViewProvider’s when an overlay plugin becomes active.

    See more

    Declaration

    Objective-C

    @protocol HYPOverlayContainer <NSObject>

    Swift

    protocol HYPOverlayContainer : NSObjectProtocol
    Show on GitHub

  • The HYPSnapshotPluginViewProvider protocol defines a mechanism for requesting the view that is placed ontop of the app when a snap shot plugin becomes active.

    See more

    Declaration

    Objective-C

    @protocol HYPSnapshotPluginViewProvider

    Swift

    protocol HYPSnapshotPluginViewProvider
    Show on GitHub

  • The HYPOverlayPluginViewProvider protocol defines a mechanism for requesting the view that is overlayed on top of the app when an Overlay plugin becomes active.

    See more

    Declaration

    Objective-C

    @protocol HYPOverlayPluginViewProvider

    Swift

    protocol HYPOverlayPluginViewProvider
    Show on GitHub

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

    @since v1.0

    See more

    Declaration

    Objective-C

    @protocol HYPPlugin <NSObject>

    Swift

    protocol HYPPlugin : NSObjectProtocol
    Show on GitHub

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

    See more

    Declaration

    Objective-C

    @protocol HYPPluginExtension <NSObject>

    Swift

    protocol HYPPluginExtension : NSObjectProtocol
    Show on GitHub

  • HYPPluginModule protocol represents an instance of a plugin.

    See more

    Declaration

    Objective-C

    @protocol HYPPluginModule <NSObject>

    Swift

    protocol HYPPluginModuleProtocol : NSObjectProtocol
    Show on GitHub

  • A delegate used to notify when a view has been selected from the ViewListPopover.

    See more

    Declaration

    Objective-C

    @protocol HYPViewSelectionDelegate <NSObject>

    Swift

    protocol HYPViewSelectionDelegate : NSObjectProtocol
    Show on GitHub