JSDoc: Class: Workspace

Constructor

new Workspace(attributes)

Creates a new Workspace instance

Parameters:

Name	Type	Description
`attributes`	WorkspaceAttributes	The workspace attributes

Source:

models/workspace.ts, line 16

Extends

BaseModel

Classes

Workspace
Workspace

Members

(static) cacheKey :string

Key used for caching workspace data

Type:

string

Source:

models/workspace.ts, line 204

cacheKey

Key used for caching workspace data

Source:

models/workspace.ts, line 26

client

The Shortcut API client instance used for making API requests

Overrides:

BaseModel#client

Source:

models/base.ts, line 8

context

The VS Code extension context

Overrides:

BaseModel#context

Source:

models/base.ts, line 10

Methods

(static) deleteCache(workspaces)

Deletes workspace cache and related caches

Parameters:

Name	Type	Description
`workspaces`	Array.<Workspace> \| undefined	Optional workspaces to clear related caches

Source:

models/workspace.ts, line 146

(static) deleteCache(workspaces)

Deletes workspace cache and related caches

Parameters:

Name	Type	Description
`workspaces`	Array.<Workspace> \| undefined	Optional workspaces to clear related caches

Source:

models/workspace.ts, line 263

(static) fromJSON(json) → {Array.<Workspace>}

Creates Workspace instances from JSON string

Parameters:

Name	Type	Description
`json`	string	JSON string containing workspace data

Source:

models/workspace.ts, line 46

Returns:

Array of Workspace instances

Type: Array.<Workspace>

(static) fromJSON(json) → {Array.<Workspace>}

Creates Workspace instances from JSON string

Parameters:

Name	Type	Description
`json`	string	JSON string containing workspace data

Source:

models/workspace.ts, line 218

Returns:

Array of Workspace instances

Type: Array.<Workspace>

(async, static) get(apiTokens) → {Promise.<Array.<Workspace>>}

Retrieves workspaces from cache or creates new ones from API tokens

Parameters:

Name	Type	Description
`apiTokens`	object \| undefined	API tokens for workspace creation

Source:

models/workspace.ts, line 95

Returns:

Array of workspace instances

Type: Promise.<Array.<Workspace>>

(async, static) get(apiTokens) → {Promise.<Array.<Workspace>>}

Retrieves workspaces from cache or creates new ones from API tokens

Parameters:

Name	Type	Description
`apiTokens`	object \| undefined	API tokens for workspace creation

Source:

models/workspace.ts, line 245

Returns:

Array of workspace instances

Type: Promise.<Array.<Workspace>>

(static) getFromCache() → {Array.<Workspace>|undefined}

Retrieves workspaces from cache

Source:

models/workspace.ts, line 127

Returns:

Array of workspace instances or undefined if cache is empty

Type: Array.<Workspace> | undefined

(static) getFromCache() → {Array.<Workspace>|undefined}

Retrieves workspaces from cache

Source:

models/workspace.ts, line 251

Returns:

Array of workspace instances or undefined if cache is empty

Type: Array.<Workspace> | undefined

(static) saveToCache(workspaces)

Saves workspaces to cache

Parameters:

Name	Type	Description
`workspaces`	Array.<Workspace>	Array of workspaces to cache

Source:

models/workspace.ts, line 138

(static) saveToCache(workspaces)

Saves workspaces to cache

Parameters:

Name	Type	Description
`workspaces`	Array.<Workspace>	Array of workspaces to cache

Source:

models/workspace.ts, line 257

(async) getAssignedStories() → {Promise.<void>}

Fetches and organizes stories assigned to the workspace member Groups stories by workflow and workflow state

Source:

models/workspace.ts, line 175

Returns:

Type: Promise.<void>

(async) getAssignedStories() → {Promise.<void>}

Fetches and organizes stories assigned to the workspace member Groups stories by workflow and workflow state

Source:

models/workspace.ts, line 285

Returns:

Type: Promise.<void>

(async) getPendingStories() → {Promise.<void>}

Fetches and updates pending stories for the workspace

Source:

models/workspace.ts, line 159

Returns:

Type: Promise.<void>

(async) getPendingStories() → {Promise.<void>}

Fetches and updates pending stories for the workspace

Source:

models/workspace.ts, line 270

Returns:

Type: Promise.<void>

(async) getWorkflows() → {Promise.<Array.<Workflow>>}

Fetches and updates workflows for the workspace

Source:

models/workspace.ts, line 166

Returns:

Array of workflows

Type: Promise.<Array.<Workflow>>

(async) getWorkflows() → {Promise.<Array.<Workflow>>}

Fetches and updates workflows for the workspace

Source:

models/workspace.ts, line 277

Returns:

Array of workflows

Type: Promise.<Array.<Workflow>>

toJSON() → {string}

Converts workspace instance to JSON string

Source:

models/workspace.ts, line 63

Returns:

JSON string representation of the workspace

Type: string

toJSON() → {string}

Converts workspace instance to JSON string

Source:

models/workspace.ts, line 224

Returns:

JSON string representation of the workspace

Type: string

toObject() → {WorkspaceAttributes}

Converts workspace instance to plain object

Source:

models/workspace.ts, line 70

Returns:

Plain object representation of the workspace

Type: WorkspaceAttributes

toObject() → {WorkspaceAttributes}

Converts workspace instance to plain object

Source:

models/workspace.ts, line 230

Returns:

Plain object representation of the workspace

Type: WorkspaceAttributes

updateAttributes(data, memberInfo)

Updates workspace attributes with new data

Parameters:

Name	Type	Description
`data`	Object	New workspace data
`memberInfo`	MemberInfo	Updated member information

Source:

models/workspace.ts, line 85

updateAttributes(data, memberInfo)

Updates workspace attributes with new data

Parameters:

Name	Type	Description
`data`	Object	New workspace data
`memberInfo`	MemberInfo	Updated member information

Source:

models/workspace.ts, line 237