Interface WHFSFile
interface WHFSFile {
dbrecord: FsObjectRow;
get contentModified(): Instant | null;
get created(): Instant;
get data(): ResourceDescriptor | null;
get description(): string;
get fileLink(): number | null;
get firstPublish(): Instant | null;
get id(): number;
get isFile(): true;
get isFolder(): false;
get isPinned(): boolean;
get isUnlisted(): boolean;
get keywords(): string;
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 publish(): boolean;
get sitePath(): string | null;
get snapshotFor(): number | null;
get target(): IntExtLink | null;
get title(): string;
get type(): keyof WHFSTypes;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
delete(): Promise<void>;
describeType(): Promise<FileTypeInfo>;
getEventMasks(types?: ("default" | "publication" | "history")[]): string[];
getPreviewLink(
options?: { password?: string; validUntil: WaitPeriod },
): Promise<string>;
listHistory(): Promise<HistoryEntry[]>;
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(): Instant | null;
get created(): Instant;
get data(): ResourceDescriptor | null;
get description(): string;
get fileLink(): number | null;
get firstPublish(): Instant | null;
get id(): number;
get isFile(): true;
get isFolder(): false;
get isPinned(): boolean;
get isUnlisted(): boolean;
get keywords(): string;
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 publish(): boolean;
get sitePath(): string | null;
get snapshotFor(): number | null;
get target(): IntExtLink | null;
get title(): string;
get type(): keyof WHFSTypes;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
delete(): Promise<void>;
describeType(): Promise<FileTypeInfo>;
getEventMasks(types?: ("default" | "publication" | "history")[]): string[];
getPreviewLink(
options?: { password?: string; validUntil: WaitPeriod },
): Promise<string>;
listHistory(): Promise<HistoryEntry[]>;
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(): Instant | null
Returns Instant | null
created
- get created(): Instant
Returns Instant
data
Returns ResourceDescriptor | null
description
- get description(): string
Returns string
file Link
- get fileLink(): number | null
Returns number | null
first Publish
- get firstPublish(): Instant | null
Returns Instant | null
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(): string | null
Returns string | null
modified
- get modified(): Instant
Returns Instant
modified By
Returns AuthorizationInterface | null
name
- get name(): string
Returns string
object Base URL
- 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
order
- get order(): number
Returns number
parent
- get parent(): number | null
Returns number | null
parent Site
- get parentSite(): number | null
Returns number | null
publish
- get publish(): boolean
Returns boolean
site Path
- get sitePath(): string | null
Returns string | null
snapshot For
- get snapshotFor(): number | null
Returns number | null
target
Returns IntExtLink | null
title
- get title(): string
Returns string
type
- get type(): keyof WHFSTypes
Returns keyof WHFSTypes
whfs Path
- get whfsPath(): string
Returns string
Methods
Protected_ do Update
Parameters
- metadata: UpdateFileMetadata | UpdateFolderMetadata
Returns Promise<void>
delete
Returns Promise<void>
describe Type
Describe this object's type
Returns Promise<FileTypeInfo>
get Event Masks
Parameters
- types: ("default" | "publication" | "history")[] = ...
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 History
Returns Promise<HistoryEntry[]>
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>
Get file data if available