ProjectEngagementCollection class
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 | .NET | JSOM | REST | Type | Description |
|---|---|---|---|---|---|
| [Integer] | ✓ | ProjectEngagement | Gets a ProjectEngagement from the collection at the specified index. | ||
| Item | ✓ | ProjectEngagement | Gets a ProjectEngagement from the collection at the specified index. |
Methods
| Name | .NET | JSOM | REST | Return Type | Description |
|---|---|---|---|---|---|
| '{ProjectEngagementId}' | ✓ | ProjectEngagement | Gets a ProjectEngagement from the collection with the specified ProjectEngagementId. | ||
| Add(ProjectEngagementCreationInformation parameters) | ✓ | ✓ | ✓ | ProjectEngagement | Adds the ProjectEngagement that is specified by the ProjectEngagementCreationInformation object to the collection. |
| GetByGuid(Guid uid) | ✓ | ✓ | ✓ | ProjectEngagement | Gets a ProjectEngagement from the collection with the Guid value. |
| GetById(String objectId) | ✓ | ✓ | ✓ | ProjectEngagement | Gets a ProjectEngagement from the collection with the Id value. |
| Remove(Engagement engagement) | ✓ | ✓ | Boolean | Removes the specified ProjectEngagement from the collection. | |
| Update() | ✓ | ✓ | void | Updates 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
| Name | Type | Description |
|---|---|---|
| ProjectEngagementId | String | the id of the ProjectEngagement |
Return Value
Add(ProjectEngagementCreationInformation parameters)
Adds the ProjectEngagement that is specified by the ProjectEngagementCreationInformation object to the collection.
Syntax
ProjectEngagement Add(ProjectEngagementCreationInformation parameters)
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | ProjectEngagementCreationInformation | The properties that can be set when creating a project engagement. |
Return Value
GetByGuid(Guid uid)
Gets a ProjectEngagement from the collection with the Guid value.
Syntax
ProjectEngagement GetByGuid(Guid uid)
Parameters
| Name | Type | Description |
|---|---|---|
| uid | Guid | The Guid of the ProjectEngagement |
Return Value
GetById(String objectId)
Gets a ProjectEngagement from the collection with the Id value.
Syntax
ProjectEngagement GetById(String objectId)
Parameters
| Name | Type | Description |
|---|---|---|
| objectId | String | The id of the ProjectEngagement. |
Return Value
Remove(Engagement engagement)
Removes the specified ProjectEngagement from the collection.
Syntax
Boolean Remove(Engagement engagement)
Parameters
| Name | Type | Description |
|---|---|---|
| engagement | Engagement | The 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