Skip to content

PersistentAI API Documentation / @persistentai/fireflow-vfs / / WorkspaceShare

Interface: WorkspaceShare

Defined in: packages/fireflow-vfs/src/types/workspace.ts:109

Workspace share - public link for sharing

Properties

createdAt

createdAt: Date

Defined in: packages/fireflow-vfs/src/types/workspace.ts:127

Creation timestamp


createdBy

createdBy: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:129

User who created the share


expiresAt?

optional expiresAt: Date

Defined in: packages/fireflow-vfs/src/types/workspace.ts:121

Optional expiration timestamp


id

id: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:111

Unique share ID (SH + 16 alphanumeric chars)


maxUses?

optional maxUses: number

Defined in: packages/fireflow-vfs/src/types/workspace.ts:123

Optional maximum usage count


pathPrefix?

optional pathPrefix: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:119

Optional path prefix to limit access


permission

permission: "editor" | "viewer"

Defined in: packages/fireflow-vfs/src/types/workspace.ts:117

Permission level for the share


shareToken

shareToken: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:115

Public share token


useCount

useCount: number

Defined in: packages/fireflow-vfs/src/types/workspace.ts:125

Current usage count


workspaceId

workspaceId: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:113

Workspace ID

Licensed under BUSL-1.1