Class Info

The API Info Class. An instance is available via the global API.v1.info variable.

Example

//== Usage:
const caseid = API.v1.info.getGlobalCaseId();
API.v1.getReference(caseid).then(ref => console.info('Reference for', caseid, 'is', ref));

Methods

getCaseId getDevParentCase getDTAP getGlobalCaseId getLocale getPlatformId getUserCaseId getUserEmail getUsername

Methods

getCaseId

  • getCaseId(): string

    Returns the caseId this widget is on (differs from globalCaseId when inside a view widget)

    Returns string

    Example

    const caseId = API.v1.info.getCaseId();

getDevParentCase

  • getDevParentCase(): string

    Returns the devParentCase for which the current page is requested.

    Returns string

    Example

    const devParentCase = API.v1.info.getDevParentCase();

getDTAP

  • getDTAP(): | ""
    | "meta"
    | "test"
    | "accept"
    | "studio"
    | "dev"
    | "demo"
    | "production"

    Get the current platform's dtap

    Returns "" | "meta" | "test" | "accept" | "studio" | "dev" | "demo" | "production"

    Example

    const dtap = API.v1.info.getDTAP();

getGlobalCaseId

  • getGlobalCaseId(): string

    Returns the caseId for which the current page is requested. NOTE: This will NOT return the 'correct' caseId when inside one or multiple view-widgets, it will always return the caseId in the address bar. When the former functionality is desired, use getCaseId() instead.

    Returns string

    Example

    const caseId = API.v1.info.getGlobalCaseId();

getLocale

  • getLocale(): string

    Returns the current locale

    Returns string

    locale in the form: "en-US" or "nl-NL"

    Example

    const locale = API.v1.info.getLocale();

getPlatformId

  • getPlatformId(): number

    Returns the current PlatformId

    Returns number

    Example

    const platformId = API.v1.info.getPlatformId();

getUserCaseId

  • getUserCaseId(): string

    Returns the user's caseId

    Returns string

    Example

    const userCase = API.v1.info.getUserCaseId();

getUserEmail

  • getUserEmail(): string

    Returns the user's mail address.

    Returns string

    Example

    const email = API.v1.info.getUserEmail();

getUsername

  • getUsername(): string

    Returns the user's name.

    Returns string

    Example

    const username = API.v1.info.getUsername();

Settings

Member Visibility

On This Page

Methods