QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Interface GetAppResponse

    interface GetAppResponse {
        ancestorId?: string;
        created?: string;
        dataClassification?: string;
        dateFormat?: string;
        description?: string;
        hasEveryoneOnTheInternet?: boolean;
        id?: string;
        memoryInfo?: { estMemory?: number; estMemoryInclDependentApps?: number };
        name: string;
        securityProperties?: {
            allowClone?: boolean;
            allowExport?: boolean;
            enableAppTokens?: boolean;
            hideFromPublic?: boolean;
            mustBeRealmApproved?: boolean;
            useIPFilter?: boolean;
            [key: string]: unknown;
        };
        timeZone?: string;
        updated?: string;
        variables?: { name?: string; value?: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    ancestorId? created? dataClassification? dateFormat? description? hasEveryoneOnTheInternet? id? memoryInfo? name securityProperties? timeZone? updated? variables?

    Properties

    ancestorId?: string

    The id of the app from which this app was copied

    created?: string

    The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

    dataClassification?: string

    The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans.

    dateFormat?: string

    A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the Field type details page in the API Guide for how time values are returned in API calls. See About Localizing Dates to set the app’s date format.

    description?: string

    The description for the app. If this property is left out, the app description will be blank.

    hasEveryoneOnTheInternet?: boolean

    Indicates whether app includes Everyone On The Internet access. See Sharing apps with Everyone on the Internet (EOTI).

    id?: string

    The unique identifier for this application.

    memoryInfo?: { estMemory?: number; estMemoryInclDependentApps?: number }

    Application memory info

    Type Declaration

    • OptionalestMemory?: number

      The estimated memory of this application in gigabytes

    • OptionalestMemoryInclDependentApps?: number

      The estimated memory of this application and all dependent applications in gigabytes

    name: string

    The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.

    securityProperties?: {
        allowClone?: boolean;
        allowExport?: boolean;
        enableAppTokens?: boolean;
        hideFromPublic?: boolean;
        mustBeRealmApproved?: boolean;
        useIPFilter?: boolean;
        [key: string]: unknown;
    }

    Security properties of the application

    Type Declaration

    • [key: string]: unknown
    • OptionalallowClone?: boolean

      Allow users who are not administrators to copy

    • OptionalallowExport?: boolean

      Allow users who are not administrators to export data

    • OptionalenableAppTokens?: boolean

      Require Application Tokens

    • OptionalhideFromPublic?: boolean

      Hide from public application searches

    • OptionalmustBeRealmApproved?: boolean

      Only "approved" users may access this application

    • OptionaluseIPFilter?: boolean

      Only users logging in from "approved" IP addresses may access this application

    timeZone?: string

    A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the Field type details page in the portal for how time values are returned in API calls. See Set the Time Zone for Both the Application and the Account to set the application’s time zone.

    updated?: string

    The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

    variables?: { name?: string; value?: string; [key: string]: unknown }[]

    The app variables. See About Application Variables

    Type Declaration

    • [key: string]: unknown
    • Optionalname?: string

      Variable name.

    • Optionalvalue?: string

      Variable value.

    Settings

    Member Visibility

    On This Page

    Properties