Interface PageStateApi

This API provides functionality that pertains to the page state. Accessed from the window at window.sas.vi.pageState.

Example

window.sas.vi.pageState.getCurrent();
interface PageStateApi {
    add(id: string | number, state: HomepageDesignerState | ObjectPageDesignerState): void;
    get(id: string | number): undefined | HomepageDesignerState | ObjectPageDesignerState;
    getCurrent(): undefined | HomepageDesignerState | ObjectPageDesignerState;
    getCurrentHomepageDesigner(): undefined | HomepageDesignerState;
    getCurrentObjectPageDesigner(): undefined | ObjectPageDesignerState;
    remove(id: string | number): void;
}

Methods

add get getCurrent getCurrentHomepageDesigner getCurrentObjectPageDesigner remove

Methods

add

  • add(id, state): void

  • Parameters

    • id: string | number

      {string | number} Page ID to be created.

    • state: HomepageDesignerState | ObjectPageDesignerState

      {HomepageDesignerState | ObjectPageDesignerState} Object containing the state data required to create the page.

    Returns void

    Method

    Description

    Creates a page state.

get

getCurrent

getCurrentHomepageDesigner

getCurrentObjectPageDesigner

remove

  • remove(id): void

  • Parameters

    • id: string | number

      {string | number} ID of the page to be deleted.

    Returns void

    Method

    Description

    Deletes a page state.

Settings

Member Visibility

On This Page

Methods