module:model/WorkspaceList

module:model/WorkspaceList

new module:model/WorkspaceList()

Source:

Constructs a new WorkspaceList.
Provides properties that describe the workspaces avaialble.

Members

(inner) endPosition :String

Source:

The last position in the result set.

Type:
  • String

(inner) resultSetSize :String

Source:

The number of results returned in this response.

Type:
  • String

(inner) startPosition :String

Source:

Starting position of the current result set.

Type:
  • String

(inner) totalSetSize :String

Source:

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

Type:
  • String

(inner) workspaces :Array.<module:model/Workspace>

Source:

A list of workspaces.

Type:

Methods

(static) constructFromObject(data, obj) → {module:model/WorkspaceList}

Source:

Constructs a WorkspaceList from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/WorkspaceList

Optional instance to populate.

Returns:

The populated WorkspaceList instance.

Type
module:model/WorkspaceList