Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PolyNav

PolyNav allows Features to interact with the user outside the confines of their container.

Hierarchy

  • PolyNav

Index

Properties

Methods

Properties

Optional actions

actions?: { back?: any; info?: any; search?: any }

Callbacks for actions the polyPod can trigger in the Feature.

Some common actions the user can take in a Feature are understood by the polyPod, and can therefore be triggered by its native user interface, which will then invoke the appropriate callback.

see

setActiveActions To set the actions that can be triggered.

Type declaration

  • back?:function
    • back(): void

    • Callback invoked for back navigation.

      Returns void

  • info?:function
    • info(): void

    • Callback invoked for showing information in the current context.

      Returns void

  • search?:function
    • search(): void

    • Callback invoked for searching in the current context.

      Returns void

Methods

openUrl

  • openUrl(url: string): Promise<void>

  • Opens a URL in an external browser - usually the user's default browser.

    Parameters

    • url: string

      The URL to open.

    Returns Promise<void>

pickFile

  • Asks the user to pick a file outside the polyPod.

    throws

    Error If an unsupported MIME type was passed as the type argument.

    Parameters

    • Optional type: string

      The MIME type of the file the user should select. If not specified, the user can select any file.

    Returns Promise<null | ExternalFile>

    A reference to the file the user selected, or null if they cancelled.

setActiveActions

  • setActiveActions(actions: string[]): Promise<void>

  • Sets the list of actions that the polyPod can trigger in the Feature, see actions. Typically called regularly to enable and disable actions depending on the current state of the Feature.

    Parameters

    • actions: string[]

      All actions that can be triggered, can be empty.

    Returns Promise<void>

setTitle

  • setTitle(title: string): Promise<void>

  • Sets the current title. Typically called regularly to show the user where they are in the Feature.

    Parameters

    • title: string

      The new title.

    Returns Promise<void>

Generated using TypeDoc