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

ProjectEngagementCollection class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObjectCollection

Syntax

CSOM

class ProjectEngagementCollection 

JSOM

PS.ProjectEngagementCollection

REST Interface

Supported.

PS.ProjectEngagementCollection

http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Projects('{projectid}')/Engagements

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
[Integer]ProjectEngagementGets a ProjectEngagement from the collection at the specified index.
ItemProjectEngagementGets a ProjectEngagement from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{ProjectEngagementId}'ProjectEngagementGets a ProjectEngagement from the collection with the specified ProjectEngagementId.
Add(ProjectEngagementCreationInformation parameters)ProjectEngagementAdds the ProjectEngagement that is specified by the ProjectEngagementCreationInformation object to the collection.
GetByGuid(Guid uid)ProjectEngagementGets a ProjectEngagement from the collection with the Id value.
GetById(String objectId)ProjectEngagementGets a ProjectEngagement from the collection with the Guid value.
Remove(Engagement engagement)BooleanRemoves the specified ProjectEngagement from the collection.
Update()voidUpdates the project engagement collection.


Method Details

'{ProjectEngagementId}'

Gets a ProjectEngagement from the collection with the specified ProjectEngagementId.

Syntax
ProjectEngagement http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Projects('{projectid}')/Engagements('{ProjectEngagementId}')
Parameters
NameTypeDescription
ProjectEngagementIdStringthe id of the ProjectEngagement
Return Value

ProjectEngagement

Add(ProjectEngagementCreationInformation parameters)

Adds the ProjectEngagement that is specified by the ProjectEngagementCreationInformation object to the collection.

Syntax
ProjectEngagement Add(ProjectEngagementCreationInformation parameters)
Parameters
NameTypeDescription
parametersProjectEngagementCreationInformationThe properties that can be set when creating a project engagement.
Return Value

ProjectEngagement

GetByGuid(Guid uid)

Gets a ProjectEngagement from the collection with the Id value.

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

ProjectEngagement

GetById(String objectId)

Gets a ProjectEngagement from the collection with the Guid value.

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

ProjectEngagement

Remove(Engagement engagement)

Removes the specified ProjectEngagement from the collection.

Syntax
Boolean Remove(Engagement engagement)
Parameters
NameTypeDescription
engagementEngagementThe ProjectEngagement to remove.
Return Value

Boolean

Update()

Updates the project engagement collection.

Syntax
void Update()
Parameters

None

Return Value

void

See Also

Project
ProjectEngagement
ProjectEngagementCreationInformation

© 2018 Microsoft