WHFSFolder | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface WHFSFolder

    interface WHFSFolder {
        dbrecord: FsObjectRow;
        get created(): Instant;
        get description(): string;
        get id(): number;
        get indexDoc(): number | null;
        get isFile(): false;
        get isFolder(): true;
        get isPinned(): boolean;
        get isUnlisted(): boolean;
        get link(): string | null;
        get modified(): Instant;
        get modifiedBy(): AuthorizationInterface | null;
        get name(): string;
        get objectBaseURL(): string | null;
        get order(): number;
        get parent(): number | null;
        get parentSite(): number | null;
        get sitePath(): string | null;
        get snapshotFor(): number | null;
        get title(): string;
        get type(): keyof WHFSTypes;
        get whfsPath(): string;
        _doUpdate(
            metadata: UpdateFileMetadata | UpdateFolderMetadata,
        ): Promise<void>;
        createFile(name: string, metadata?: CreateFileMetadata): Promise<WHFSFile>;
        createFolder(
            name: string,
            metadata?: CreateFolderMetadata,
        ): Promise<WHFSFolder>;
        delete(): Promise<void>;
        describeType(): Promise<FolderTypeInfo>;
        ensureFile(
            name: string,
            requiredmetadata?: UpdateFileMetadata,
            options?: { ifNew: UpdateFileMetadata },
        ): Promise<WHFSFile>;
        ensureFolder(
            name: string,
            requiredmetadata?: UpdateFolderMetadata,
            options?: { ifNew: UpdateFolderMetadata },
        ): Promise<WHFSFolder>;
        generateName(
            suggestion: string,
            options?: { ignoreObject?: number | null; slugify?: boolean },
        ): Promise<string>;
        getBaseURL(): Promise<string | null>;
        getEventMasks(types?: ("default" | "publication" | "history")[]): string[];
        list<K extends keyof ListableFsObjectRow = never>(
            keys?: K[],
            options?: ListFSOptions,
        ): Promise<WHFSListResult<K>[]>;
        listHistory(): Promise<HistoryEntry[]>;
        listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
        listRecursive<K extends keyof ListableFsObjectRow = never>(
            keys?: K[],
            options?: ListFSRecursiveOptions,
        ): Promise<WHFSRecursiveListResult<K>[]>;
        openFile(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<WHFSFile | null>;
        openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
        openFileOrFolder(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<WHFSFolder | WHFSFile | null>;
        openFileOrFolder(
            path: string,
            options?: OpenWHFSObjectOptions,
        ): Promise<WHFSFolder | WHFSFile>;
        openFolder(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<WHFSFolder | null>;
        openFolder(
            path: string,
            options?: OpenWHFSObjectOptions,
        ): Promise<WHFSFolder>;
        openParent(
            __namedParameters?: { allowRoot?: boolean },
        ): Promise<WHFSFolder>;
        recycle(): Promise<void>;
        refresh(options: { allowMissing: true }): Promise<boolean>;
        refresh(options?: { allowMissing?: boolean }): Promise<true>;
        update(metadata: UpdateFolderMetadata): Promise<void>;
    }

    Hierarchy

    • WHFSBaseObject
      • WHFSFolder
    Index

    Properties

    dbrecord: FsObjectRow

    Accessors

    • get created(): Instant

      Returns Instant

    • get description(): string

      Returns string

    • get id(): number

      Returns number

    • get indexDoc(): number | null

      Returns number | null

    • get isFile(): false

      Returns false

    • get isFolder(): true

      Returns true

    • get isPinned(): boolean

      Returns boolean

    • get isUnlisted(): boolean

      Returns boolean

    • Returns string | null

    • get modified(): Instant

      Returns Instant

    • get name(): string

      Returns string

    • get objectBaseURL(): string | null

      The URL of the object itself. For folders this is the folder's base URL (unlike 'link', which is the URL of its index document). null if the object has no URL

      Returns string | null

    • get order(): number

      Returns number

    • get parent(): number | null

      Returns number | null

    • get parentSite(): number | null

      Returns number | null

    • get sitePath(): string | null

      Returns string | null

    • get snapshotFor(): number | null

      Returns number | null

    • get title(): string

      Returns string

    • get type(): keyof WHFSTypes

      Returns keyof WHFSTypes

    • get whfsPath(): string

      Returns string

    Methods

    • Returns Promise<void>

    • Describe this object's type

      Returns Promise<FolderTypeInfo>

    • Generate a unique name for a new object in this folder

      Parameters

      • suggestion: string

        Suggested name for the new object. If this name is already taken, a counter will be appended to the name

      • options: { ignoreObject?: number | null; slugify?: boolean } = {}

        Options for generating the name

        • OptionalignoreObject?: number | null

          Ignore this object when looking for a free name (usually refers to an object being renamed as it shouldn't clash with itself)

        • Optionalslugify?: boolean

          Slugify the suggested name, defaults to true

      Returns Promise<string>

    • Get the base URL for items in this folder if it was published. Does not follow or use the indexDoc

      Returns Promise<string | null>

      • The base URL for this folder or an empty string if its site is not published
    • Parameters

      • types: ("default" | "publication" | "history")[] = ...

      Returns string[]

    • Type Parameters

      • K extends keyof ListableFsObjectRow = never

      Parameters

      • Optionalkeys: K[]
      • Optionaloptions: ListFSOptions

      Returns Promise<WHFSListResult<K>[]>

    • Returns Promise<HistoryEntry[]>

    • Parameters

      • Optionaloptions: ListInstancesOptions

      Returns Promise<ListInstancesResult>

    • Type Parameters

      • K extends keyof ListableFsObjectRow = never

      Parameters

      • Optionalkeys: K[]
      • Optionaloptions: ListFSRecursiveOptions

      Returns Promise<WHFSRecursiveListResult<K>[]>

    • Parameters

      • path: string
      • options: OpenWHFSObjectOptions & { allowMissing: true }

      Returns Promise<WHFSFile | null>

    • Parameters

      • path: string
      • Optionaloptions: OpenWHFSObjectOptions

      Returns Promise<WHFSFile>

    • Parameters

      • path: string
      • options: OpenWHFSObjectOptions & { allowMissing: true }

      Returns Promise<WHFSFolder | WHFSFile | null>

    • Parameters

      • path: string
      • Optionaloptions: OpenWHFSObjectOptions

      Returns Promise<WHFSFolder | WHFSFile>

    • Parameters

      • path: string
      • options: OpenWHFSObjectOptions & { allowMissing: true }

      Returns Promise<WHFSFolder | null>

    • Parameters

      • path: string
      • Optionaloptions: OpenWHFSObjectOptions

      Returns Promise<WHFSFolder>

    • Open the parent folder for this object

      Parameters

      • __namedParameters: { allowRoot?: boolean } = {}

      Returns Promise<WHFSFolder>

      Error if this is a root subfolder

    • Returns Promise<void>

    • Re-read cached data from the database, returns whether the object still exists

      Parameters

      • options: { allowMissing: true }

      Returns Promise<boolean>

    • Re-read cached data from the database, throws when the object doesn't exist anymore

      Parameters

      • Optionaloptions: { allowMissing?: boolean }

      Returns Promise<true>