Interface WHFSFile
interface WHFSFile {
dbrecord: FsObjectRow;
get contentModified(): null | Instant;
get created(): Instant;
get data(): ResourceDescriptor;
get description(): string;
get fileLink(): null | number;
get firstPublish(): null | Instant;
get id(): number;
get isFile(): true;
get isFolder(): false;
get isPinned(): boolean;
get isUnlisted(): boolean;
get keywords(): string;
get link(): null | string;
get modified(): Instant;
get name(): string;
get ordering(): number;
get parent(): null | number;
get parentSite(): null | number;
get publish(): boolean;
get sitePath(): null | string;
get title(): string;
get type(): string;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
delete(): Promise<void>;
describeType(): Promise<FileTypeInfo>;
getEventMasks(types?: ("default" | "history" | "publication")[]): string[];
getPreviewLink(
options?: { password?: string; validUntil: WaitPeriod },
): Promise<string>;
listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
openParent(
__namedParameters?: { allowRoot?: boolean },
): Promise<WHFSFolder>;
recycle(): Promise<void>;
refresh(options: { allowMissing: true }): Promise<boolean>;
refresh(options?: { allowMissing?: boolean }): Promise<true>;
republish(): Promise<void>;
update(metadata: UpdateFileMetadata): Promise<void>;
}
dbrecord: FsObjectRow;
get contentModified(): null | Instant;
get created(): Instant;
get data(): ResourceDescriptor;
get description(): string;
get fileLink(): null | number;
get firstPublish(): null | Instant;
get id(): number;
get isFile(): true;
get isFolder(): false;
get isPinned(): boolean;
get isUnlisted(): boolean;
get keywords(): string;
get link(): null | string;
get modified(): Instant;
get name(): string;
get ordering(): number;
get parent(): null | number;
get parentSite(): null | number;
get publish(): boolean;
get sitePath(): null | string;
get title(): string;
get type(): string;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
delete(): Promise<void>;
describeType(): Promise<FileTypeInfo>;
getEventMasks(types?: ("default" | "history" | "publication")[]): string[];
getPreviewLink(
options?: { password?: string; validUntil: WaitPeriod },
): Promise<string>;
listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
openParent(
__namedParameters?: { allowRoot?: boolean },
): Promise<WHFSFolder>;
recycle(): Promise<void>;
refresh(options: { allowMissing: true }): Promise<boolean>;
refresh(options?: { allowMissing?: boolean }): Promise<true>;
republish(): Promise<void>;
update(metadata: UpdateFileMetadata): Promise<void>;
}
Hierarchy
- WHFSBaseObject
- WHFSFile
Index
Properties
Accessors
Methods
Accessors
content Modified
- get contentModified(): null | Instant
Returns null | Instant
created
- get created(): Instant
Returns Instant
data
Returns ResourceDescriptor
description
- get description(): string
Returns string
file Link
- get fileLink(): null | number
Returns null | number
first Publish
- get firstPublish(): null | Instant
Returns null | Instant
id
- get id(): number
Returns number
is File
- get isFile(): true
Returns true
is Folder
- get isFolder(): false
Returns false
is Pinned
- get isPinned(): boolean
Returns boolean
is Unlisted
- get isUnlisted(): boolean
Returns boolean
keywords
- get keywords(): string
Returns string
link
- get link(): null | string
Returns null | string
modified
- get modified(): Instant
Returns Instant
name
- get name(): string
Returns string
ordering
- get ordering(): number
Returns number
parent
- get parent(): null | number
Returns null | number
parent Site
- get parentSite(): null | number
Returns null | number
publish
- get publish(): boolean
Returns boolean
site Path
- get sitePath(): null | string
Returns null | string
title
- get title(): string
Returns string
type
- get type(): string
Returns string
whfs Path
- get whfsPath(): string
Returns string
Methods
Protected_ do Update
Parameters
- metadata: UpdateFileMetadata | UpdateFolderMetadata
Returns Promise<void>
delete
Returns Promise<void>
describe Type
Returns Promise<FileTypeInfo>
get Event Masks
Parameters
- types: ("default" | "history" | "publication")[] = ...
Returns string[]
get Preview Link
Get a preview link for a document
Parameters
Optionaloptions: { password?: string; validUntil: WaitPeriod }Optionalpassword?: stringPassword to protect the preview with
validUntil: WaitPeriod
Validity of the link. Defaults to 1 day
Returns Promise<string>
list Instances
Parameters
Optionaloptions: ListInstancesOptions
Returns Promise<ListInstancesResult>
open Parent
Open the parent folder for this object
Parameters
- __namedParameters: { allowRoot?: boolean } = {}
Returns Promise<WHFSFolder>
recycle
Returns Promise<void>
refresh
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>
republish
Returns Promise<void>
update
Parameters
- metadata: UpdateFileMetadata
Returns Promise<void>
Describe this object's type