Phials plugin documentation
User guide
AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

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>;
    listKnown(): Promise<readonly KnownWorkspaceFolder[]>;
    openPage(file: WorkspaceFolderFileRef, options?: {
        focusEditor?: boolean;
        sourcePaneId?: string;
    }): Promise<void>;
}

Members

NameTypeRequiredDescription
isWorkspaceFolder(path: string) => Promise<boolean>yes-
getSchema(workspaceFolderIdOrPath: string) => Promise<WorkspaceFolderSchema>yes-
getPropertyValue(file:WorkspaceFolderFileRef, propertyId: string) => Promise<WorkspaceFolderPropertyValue| null>yes-
setPropertyValue(file:WorkspaceFolderFileRef, propertyId: string, value:WorkspaceFolderPropertyValue| null) => Promise<void>yes-
setPropertyValues(file:WorkspaceFolderFileRef, values: readonlyWorkspaceFolderPropertyWrite[]) => Promise<void>yes-
getTags(file:WorkspaceFolderFileRef) => Promise<readonly string[]>yes-
setTags(file:WorkspaceFolderFileRef, tags: readonly string[]) => Promise<void>yes-
getRating(file:WorkspaceFolderFileRef) => Promise<number | null>yes-
setRating(file:WorkspaceFolderFileRef, rating: number | null) => Promise<void>yes-
listKnown() => Promise<readonlyKnownWorkspaceFolder[]>yes-
openPage(file:WorkspaceFolderFileRef, options?: { … }) => Promise<void>yes-