Table of contents
API
TOC
Collapse the table of content
Expand the table of content

PhaseCollection class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObjectCollection

Represents a collection of workflow Phase objects.

Syntax

CSOM

class PhaseCollection 

JSOM

PS.PhaseCollection

REST Interface

Supported.

PS.PhaseCollection

http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Phases

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
[Integer]PhaseGets a Phase from the collection at the specified index.
ItemPhaseGets a Phase from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{PhaseId}'PhaseGets a Phase from the collection with the specified PhaseId.
Add(PhaseCreationInformation parameters)PhaseAdds the Phase that is specified by the PhaseCreationInformation object to the collection.
GetByGuid(Guid uid)PhaseGets a Phase from the collection with the Id value.
GetById(String objectId)PhaseGets a Phase from the collection with the Guid value.
Remove(Phase phase)BooleanRemoves the specified Phase from the collection.
Update()voidUpdates the phase collection.


Method Details

'{PhaseId}'

Gets a Phase from the collection with the specified PhaseId.

Syntax
Phase http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Phases('{PhaseId}')
Parameters
NameTypeDescription
PhaseIdStringthe id of the Phase
Return Value

Phase

Add(PhaseCreationInformation parameters)

Adds the Phase that is specified by the PhaseCreationInformation object to the collection.

Syntax
Phase Add(PhaseCreationInformation parameters)
Parameters
NameTypeDescription
parametersPhaseCreationInformationThe properties that can be set when creating a phase.
Return Value

Phase

GetByGuid(Guid uid)

Gets a Phase from the collection with the Id value.

Syntax
Phase GetByGuid(Guid uid)
Parameters
NameTypeDescription
uidGuidThe Guid of the Phase
Return Value

Phase

GetById(String objectId)

Gets a Phase from the collection with the Guid value.

Syntax
Phase GetById(String objectId)
Parameters
NameTypeDescription
objectIdStringThe id of the Phase.
Return Value

Phase

Remove(Phase phase)

Removes the specified Phase from the collection.

Syntax
Boolean Remove(Phase phase)
Parameters
NameTypeDescription
phasePhaseThe Phase to remove.
Return Value

Boolean

Update()

Updates the phase collection.

Syntax
void Update()
Parameters

None

Return Value

void

See Also

Phase
PhaseCreationInformation
ProjectContext

© 2018 Microsoft