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(): null | number;
        get isFile(): false;
        get isFolder(): true;
        get isPinned(): boolean;
        get isUnlisted(): boolean;
        get link(): null | string;
        get modified(): Instant;
        get name(): string;
        get ordering(): number;
        get parent(): null | number;
        get parentSite(): null | number;
        get sitePath(): null | string;
        get title(): string;
        get type(): string;
        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?: null | number; slugify?: boolean },
        ): Promise<string>;
        getBaseURL(): Promise<null | string>;
        list<K extends keyof ListableFsObjectRow = never>(
            keys?: K[],
        ): Promise<Pick<ListableFsObjectRow, "name" | "id" | "isFolder" | K>[]>;
        listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
        openFile(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<null | WHFSFile>;
        openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
        openFileOrFolder(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<null | WHFSFile | WHFSFolder>;
        openFileOrFolder(
            path: string,
            options?: OpenWHFSObjectOptions,
        ): Promise<WHFSFile | WHFSFolder>;
        openFolder(
            path: string,
            options: OpenWHFSObjectOptions & { allowMissing: true },
        ): Promise<null | WHFSFolder>;
        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(): null | number

      Returns null | number

    • get isFile(): false

      Returns false

    • get isFolder(): true

      Returns true

    • get isPinned(): boolean

      Returns boolean

    • get isUnlisted(): boolean

      Returns boolean

    • Returns null | string

    • get modified(): Instant

      Returns Instant

    • get name(): string

      Returns string

    • get ordering(): number

      Returns number

    • get parent(): null | number

      Returns null | number

    • get parentSite(): null | number

      Returns null | number

    • get sitePath(): null | string

      Returns null | string

    • get title(): string

      Returns string

    • get type(): string

      Returns string

    • 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?: null | number; slugify?: boolean } = {}

        Options for generating the name

        • OptionalignoreObject?: null | number

          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<null | string>

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

      • K extends keyof ListableFsObjectRow = never

      Parameters

      • Optionalkeys: K[]

      Returns Promise<Pick<ListableFsObjectRow, "name" | "id" | "isFolder" | K>[]>

    • Parameters

      • Optionaloptions: ListInstancesOptions

      Returns Promise<ListInstancesResult>

    • Parameters

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

      Returns Promise<null | WHFSFile>

    • Parameters

      • path: string
      • Optionaloptions: OpenWHFSObjectOptions

      Returns Promise<WHFSFile>

    • Parameters

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

      Returns Promise<null | WHFSFile | WHFSFolder>

    • Parameters

      • path: string
      • Optionaloptions: OpenWHFSObjectOptions

      Returns Promise<WHFSFile | WHFSFolder>

    • Parameters

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

      Returns Promise<null | WHFSFolder>

    • 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>