Skip to content

WorkspaceFoldersAPI

Since Plugin API: 1.0.0

Signature

interface WorkspaceFoldersAPI {
isWorkspaceFolder(path: string): Promise<boolean>;
getSchema(workspaceFolderIdOrPath: string): Promise<WorkspaceFolderSchema>;
getPropertyValue(file: WorkspaceFolderFileRef, propertyId: string): Promise<WorkspaceFolderPropertyValue | null>;
setPropertyValue(file: WorkspaceFolderFileRef, propertyId: string, value: WorkspaceFolderPropertyValue | null): Promise<void>;
setPropertyValues(file: WorkspaceFolderFileRef, values: readonly WorkspaceFolderPropertyWrite[]): Promise<void>;
getTags(file: WorkspaceFolderFileRef): Promise<readonly string[]>;
setTags(file: WorkspaceFolderFileRef, tags: readonly string[]): Promise<void>;
getRating(file: WorkspaceFolderFileRef): Promise<number | null>;
setRating(file: WorkspaceFolderFileRef, rating: number | null): Promise<void>;
getCalendar(file: WorkspaceFolderFileRef): Promise<WorkspaceFolderCalendarValue | null>;
setCalendar(file: WorkspaceFolderFileRef, value: WorkspaceFolderCalendarValue | null): Promise<void>;
listKnown(): Promise<readonly KnownWorkspaceFolder[]>;
openPage(file: WorkspaceFolderFileRef, options?: {
focusEditor?: boolean;
sourcePaneId?: string;
}): Promise<void>;
}

Members

Name Type Required Description
isWorkspaceFolder (path: string) => Promise<boolean> yes -
getSchema (workspaceFolderIdOrPath: string) => Promise<WorkspaceFolderSchema> yes -
getPropertyValue (file: WorkspaceFolderFileRef, propertyId: string) => Promise<WorkspaceFolderPropertyValue &#124; null> yes -
setPropertyValue (file: WorkspaceFolderFileRef, propertyId: string, value: WorkspaceFolderPropertyValue &#124; null) => Promise<void> yes -
setPropertyValues (file: WorkspaceFolderFileRef, values: readonly WorkspaceFolderPropertyWrite[]) => Promise<void> yes -
getTags (file: WorkspaceFolderFileRef) => Promise<readonly string[]> yes -
setTags (file: WorkspaceFolderFileRef, tags: readonly string[]) => Promise<void> yes -
getRating (file: WorkspaceFolderFileRef) => Promise<number &#124; null> yes -
setRating (file: WorkspaceFolderFileRef, rating: number &#124; null) => Promise<void> yes -
getCalendar (file: WorkspaceFolderFileRef) => Promise<WorkspaceFolderCalendarValue &#124; null> yes -
setCalendar (file: WorkspaceFolderFileRef, value: WorkspaceFolderCalendarValue &#124; null) => Promise<void> yes -
listKnown () => Promise<readonly KnownWorkspaceFolder[]> yes -
openPage (file: WorkspaceFolderFileRef, options?: { … }) => Promise<void> yes -

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.