Class: Depot

Depot

new Depot(obj)

Initialize a new depot instance.

Parameters:
Name Type Description
obj Object

Data from the server, which doesn't follow typical javaScript naming conventions.

Source:

Members

address :string

If type is 'remote', this is the P4PORT address of the remote server.

Type:
  • string
Source:

children :Array.<PathItem>

The immediate directories and files under this depot.

Type:
  • Array.<PathItem>
Source:

(readonly) data :object

The representation of the depot suitable to POST back to the Helix Web Services Perforce API.

Type:
  • object
Source:

(readonly) date :Date

The created date of the depot

Type:
  • Date
Source:

depot :string

The name of the Depot

Type:
  • string
Source:

description :string

A short description of the depot's purpose.

Type:
  • string
Source:

map :string

If type is 'local', 'spec', or 'archive', this points to the relative location of the depot subdirectory.

Type:
  • string
Source:

(readonly) name :string

Used by our underlying Node representation

Type:
  • string
Source:

owner :string

The user login that owns the Depot.

Type:
  • string
Source:

(readonly) pathId :string

Used by our underlying Node representation

Type:
  • string
Source:

specMap :string

When type is 'spec', this an optional description of what specs should be saved.

Type:
  • string
Source:

suffix :string

If the type is 'spec', this holds an optional suffix for generated paths to objects in the spec depot.

Type:
  • string
Source:

type :string

The Depot type, one of 'local', 'remote', 'spec', 'stream', 'unload', or 'archive'.

Type:
  • string
Source: