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

    Type Alias ResourceType

    type ResourceType = {
        createResourceType(
            resourceTypeData: ResourceTypeSkeleton,
            resourceTypeUuid?: string,
        ): Promise<ResourceTypeSkeleton>;
        deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
        deleteResourceTypeByName(
            resourceTypeName: string,
        ): Promise<ResourceTypeSkeleton>;
        exportResourceType(
            resourceTypeUuid: string,
        ): Promise<ResourceTypeExportInterface>;
        exportResourceTypeByName(
            resourceTypeName: string,
        ): Promise<ResourceTypeExportInterface>;
        exportResourceTypes(): Promise<ResourceTypeExportInterface>;
        getResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
        getResourceTypeByName(
            resourceTypeName: string,
        ): Promise<ResourceTypeSkeleton>;
        getResourceTypes(): Promise<ResourceTypeSkeleton[]>;
        importFirstResourceType(
            importData: ResourceTypeExportInterface,
        ): Promise<any>;
        importResourceType(
            resourceTypeUuid: string,
            importData: ResourceTypeExportInterface,
        ): Promise<any>;
        importResourceTypeByName(
            resourceTypeName: string,
            importData: ResourceTypeExportInterface,
        ): Promise<any>;
        importResourceTypes(
            importData: ResourceTypeExportInterface,
        ): Promise<any[]>;
        readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
        readResourceTypeByName(
            resourceTypeName: string,
        ): Promise<ResourceTypeSkeleton>;
        readResourceTypes(): Promise<ResourceTypeSkeleton[]>;
        updateResourceType(
            resourceTypeUuid: string,
            resourceTypeData: ResourceTypeSkeleton,
        ): Promise<ResourceTypeSkeleton>;
    }
    Index

    Methods

    createResourceType deleteResourceType deleteResourceTypeByName exportResourceType exportResourceTypeByName exportResourceTypes importFirstResourceType importResourceType importResourceTypeByName importResourceTypes readResourceType readResourceTypeByName readResourceTypes updateResourceType

    Deprecated

    getResourceType getResourceTypeByName getResourceTypes

    Methods

    Deprecated

    • Get resource type

      Parameters

      • resourceTypeUuid: string

        resource type uuid

      Returns Promise<ResourceTypeSkeleton>

      a promise that resolves to a resource type object

      since v2.0.0 use Agent.readResourceType | readResourceType instead

      readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>

    • Get resource type by name

      Parameters

      • resourceTypeName: string

        resource type name

      Returns Promise<ResourceTypeSkeleton>

      a promise that resolves to a resource type object

      since v2.0.0 use Agent.readResourceTypeByName | readResourceTypeByName instead

      readResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>

    • Get all resource types

      Returns Promise<ResourceTypeSkeleton[]>

      a promise that resolves to an array of resource type objects

      since v2.0.0 use Agent.readResourceTypes | readResourceTypes instead

      readResourceTypes(): Promise<ResourceTypeSkeleton[]>

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated