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

    Type Alias IdmConfig

    type IdmConfig = {
        createConfigEntity(
            entityId: string,
            entityData: IdObjectSkeletonInterface,
            wait?: boolean,
        ): Promise<IdObjectSkeletonInterface>;
        deleteConfigEntities(
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        deleteConfigEntitiesByType(
            type: string,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        deleteConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
        exportConfigEntities(
            options?: ConfigEntityExportOptions,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<ConfigEntityExportInterface>;
        exportConfigEntity(
            entityId: string,
            options?: ConfigEntityExportOptions,
        ): Promise<ConfigEntityExportInterface>;
        getAllConfigEntities(): Promise<IdmConfigStub[]>;
        getConfigEntitiesByType(type: string): Promise<IdObjectSkeletonInterface[]>;
        getConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
        getConfigEntityTypes(): Promise<string[]>;
        importConfigEntities(
            importData: ConfigEntityExportInterface,
            entityId?: string,
            options?: ConfigEntityImportOptions,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        importSubConfigEntity(
            entityId: string,
            updatedSubConfigEntity: IdObjectSkeletonInterface,
            options?: ConfigEntityImportOptions,
        ): Promise<IdObjectSkeletonInterface[]>;
        putConfigEntity(
            entityId: string,
            entityData: IdObjectSkeletonInterface,
        ): Promise<IdObjectSkeletonInterface>;
        readConfigEntities(): Promise<IdObjectSkeletonInterface[]>;
        readConfigEntitiesByType(
            type: string,
            includeDefault?: boolean,
        ): Promise<IdObjectSkeletonInterface[]>;
        readConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
        readConfigEntityStubs(): Promise<IdmConfigStub[]>;
        readConfigEntityTypes(): Promise<string[]>;
        readSubConfigEntity(
            entityId: string,
            name: string,
            options?: ConfigEntityExportOptions,
        ): Promise<NoIdObjectSkeletonInterface>;
        testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
        updateConfigEntity(
            entityId: string,
            entityData: IdObjectSkeletonInterface,
            wait?: boolean,
        ): Promise<IdObjectSkeletonInterface>;
    }
    Index

    Methods

    createConfigEntity deleteConfigEntities deleteConfigEntitiesByType deleteConfigEntity exportConfigEntities exportConfigEntity importConfigEntities importSubConfigEntity readConfigEntities readConfigEntitiesByType readConfigEntity readConfigEntityStubs readConfigEntityTypes readSubConfigEntity testConnectorServers updateConfigEntity

    Deprecated

    getAllConfigEntities getConfigEntitiesByType getConfigEntity getConfigEntityTypes putConfigEntity

    Methods

    • Read all config entities of a type

      Parameters

      • type: string

        config entity type

      • OptionalincludeDefault: boolean

        Include default email templates if true, false to exclude them. Default: false

      Returns Promise<IdObjectSkeletonInterface[]>

      promise resolving to an array of config entities of a type

    • Read available config entity types

      Returns Promise<string[]>

      promise resolving to an array of config entity types

    Deprecated

    • Get available config entity types

      Returns Promise<string[]>

      promise resolving to an array of config entity types

      since v2.0.0 use readConfigEntityTypes instead

      readConfigEntityTypes(): Promise<string[]>

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated