Interface IClassApps

Hierarchy

  • IClassApps

Implemented by

Methods

exportMany get getAll getFilter removeFilter select upload uploadAndReplace uploadMany

Methods

exportMany

  • Export multiple qvf to Buffer

    Parameters

    • Optional arg: {
          filter: string;
          skipData?: boolean;
      }
      • filter: string
      • Optional skipData?: boolean

    Returns Promise<{
        exportToken: string;
        file: IncomingMessage;
        name: string;
    }[]>

get

  • Get single app instance

    Parameters

    • arg: {
          id: string;
      }
      • id: string

    Returns Promise<App>

getAll

  • Get all available apps instance for a user

    Returns Promise<App[]>

getFilter

  • Get array of apps instance based on the supplied filter

    Parameters

    • arg: {
          filter: string;
          orderBy?: string;
      }
      • filter: string
      • Optional orderBy?: string

    Returns Promise<App[]>

removeFilter

  • Remove apps based on the supplied filter

    Parameters

    • arg: {
          filter: string;
      }
      • filter: string

    Returns Promise<IEntityRemove[]>

select

  • Create selection based on the supplied filter

    Parameters

    • Optional arg: {
          filter: string;
      }
      • filter: string

    Returns Promise<ISelection>

upload

  • Upload an qvf

    Parameters

    • arg: {
          excludeDataConnections?: boolean;
          file: Buffer;
          keepData?: boolean;
          name: string;
      }
      • Optional excludeDataConnections?: boolean
      • file: Buffer
      • Optional keepData?: boolean
      • name: string

    Returns Promise<App>

uploadAndReplace

  • EXPERIMENTAL

    Upload an qvf and replace an existing app with it

    Parameters

    • arg: {
          file: Buffer;
          keepData?: boolean;
          name: string;
          targetAppId: string;
      }
      • file: Buffer
      • Optional keepData?: boolean
      • name: string
      • targetAppId: string

    Returns Promise<App>

uploadMany

  • Upload multiple apps in a single method

    Parameters

    • arg: {
          apps: [{
              excludeDataConnections?: boolean;
              file: Buffer;
              keepData?: boolean;
              name: string;
          }];
          sequence?: Boolean;
      }
      • apps: [{
            excludeDataConnections?: boolean;
            file: Buffer;
            keepData?: boolean;
            name: string;
        }]
      • Optional sequence?: Boolean

    Returns Promise<App[]>

Settings

Member Visibility

Theme

On This Page