Variable presentationConst

Type Declaration

• get: function

  • get(): Promise<Presentation>

    Get the presentation that is currently open.

    Returns Promise<Presentation>

    The current Presentation.

    Throws

    MobileLockerError on network failure or server error.

• getEvents: function

  • getEvents(): Promise<unknown[]>

    Get the analytics events recorded for the current presentation session.

    Returns Promise<unknown[]>

    Array of raw event objects.

    Throws

    MobileLockerError on network failure or server error.

• getDeviceEvents: function

  • getDeviceEvents(): Promise<unknown[]>

    Alias for getEvents.

    Returns Promise<unknown[]>

    Array of raw event objects.

• reload: function

  • reload(): void

    Reload the current presentation's web content.

    Triggers a full page reload inside the presentation webview.

    Returns void

• close: function

  • close(): void

    Close the current presentation and return to the app home screen.

    Returns void

• getAll: function

  • getAll(): Promise<Presentation[]>

    Get all presentations available to the current user.

    Returns Promise<Presentation[]>

    Array of Presentation objects.

    Throws

    MobileLockerError on network failure or server error.

• getByID: function

  • getByID(id: number): Promise<Presentation>

    Get a presentation by its numeric ID.

    Parameters

    • id: number

      The presentation ID.

    Returns Promise<Presentation>

    The matching Presentation.

    Throws

    MobileLockerError on network failure, or if not found.

• getByName: function

  • getByName(name: string): Promise<Presentation>

    Get a presentation by its name.

    Parameters

    • name: string

      The presentation name (case-sensitive).

    Returns Promise<Presentation>

    The matching Presentation.

    Throws

    MobileLockerError on network failure, or if not found.

• refresh: function

  • refresh(): Promise<Presentation[]>

    Refresh the list of available presentations from the server.

    Returns Promise<Presentation[]>

    Updated array of Presentation objects.

    Throws

    MobileLockerError on network failure or server error.

• download: function

  • download(id: number): Promise<DownloadResult>

    Queue a presentation for download to the device.

    Parameters

    • id: number

      The numeric ID of the presentation to download.

    Returns Promise<DownloadResult>

    An object with status: 'queued', 'already_installed', 'not_available', or 'not_permitted'.

    Throws

    MobileLockerError on network failure or server error.

• openByID: function

  • openByID(id: number): void

    Open a presentation by its numeric ID.

    Parameters

    • id: number

      The numeric ID of the presentation to open.

    Returns void

    Remarks

    iOS app only. Throws in all other environments.

    Throws

    MobileLockerError if called outside the iOS app.

• openByExternalID: function

  • openByExternalID(externalID: string): void

    Open a presentation by its external CRM ID.

    Parameters

    • externalID: string

      The external identifier for the presentation (e.g. a Salesforce ID).

    Returns void

    Remarks

    iOS app only. Throws in all other environments.

    Throws

    MobileLockerError if called outside the iOS app.

• openByName: function

  • openByName(name: string): void

    Open a presentation by its name.

    Parameters

    • name: string

      The presentation name (case-sensitive).

    Returns void

    Remarks

    iOS app only. Throws in all other environments.

    Throws

    MobileLockerError if called outside the iOS app.

• openPicker: function

  • openPicker(): void

    Open the native presentation picker so the user can choose a presentation to open.

    Returns void

    Remarks

    iOS app only. Throws in all other environments.

    Throws

    MobileLockerError if called outside the iOS app.