Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Application

    type Application = {
        createApplication(
            applicationId: string,
            applicationData: ApplicationSkeleton,
        ): Promise<ApplicationSkeleton>;
        createApplicationExportTemplate(): ApplicationExportInterface;
        deleteApplication(
            applicationId: string,
            deep?: boolean,
        ): Promise<ApplicationSkeleton>;
        deleteApplicationByName(
            applicationName: string,
            deep?: boolean,
        ): Promise<ApplicationSkeleton>;
        deleteApplications(deep?: boolean): Promise<ApplicationSkeleton[]>;
        exportApplication(
            applicationId: string,
            options: ApplicationExportOptions,
        ): Promise<ApplicationExportInterface>;
        exportApplicationByName(
            applicationName: string,
            options: ApplicationExportOptions,
        ): Promise<ApplicationExportInterface>;
        exportApplications(
            options?: ApplicationExportOptions,
        ): Promise<ApplicationExportInterface>;
        getRealmManagedApplication(): string;
        importApplication(
            applicationId: string,
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationSkeleton>;
        importApplicationByName(
            applicationName: string,
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationSkeleton>;
        importApplications(
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationSkeleton[]>;
        importFirstApplication(
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationSkeleton[]>;
        queryApplications(
            filter: string,
            fields?: string[],
        ): Promise<ApplicationSkeleton[]>;
        readApplication(applicationId: string): Promise<ApplicationSkeleton>;
        readApplicationByName(
            applicationName: string,
        ): Promise<ApplicationSkeleton>;
        readApplications(): Promise<ApplicationSkeleton[]>;
        updateApplication(
            applicationId: string,
            applicationData: ApplicationSkeleton,
        ): Promise<ApplicationSkeleton>;
    }
    Index

    Methods

    createApplication createApplicationExportTemplate deleteApplication deleteApplicationByName deleteApplications exportApplication exportApplicationByName exportApplications getRealmManagedApplication importApplication importApplicationByName importApplications importFirstApplication queryApplications readApplication readApplicationByName readApplications updateApplication

    Methods

    • Delete application

      Parameters

      • applicationId: string

        application uuid

      • Optionaldeep: boolean

        deep delete (remove dependencies)

      Returns Promise<ApplicationSkeleton>

      a promise that resolves to an application object

    • Delete application by name

      Parameters

      • applicationName: string

        application name

      • Optionaldeep: boolean

        deep delete (remove dependencies)

      Returns Promise<ApplicationSkeleton>

      a promise that resolves to an application object

    • Get application managed object type

      Returns string

      application managed object type in this realm

    Settings

    Member Visibility

    On This Page

    Methods