EventHandlerCollection class

inherits members from ClientObjectCollection

Represents a collection of EventHandler objects.

Syntax

CSOM

class EventHandlerCollection 

JSOM

PS.EventHandlerCollection

REST Interface

Supported.

PS.EventHandlerCollection

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

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name .NET JSOM REST Type Description
[Integer] EventHandler Gets a EventHandler from the collection at the specified index.
Item EventHandler Gets a EventHandler from the collection at the specified index.

Methods

Name .NET JSOM REST Return Type Description
'{EventHandlerId}' EventHandler Gets a EventHandler from the collection with the specified EventHandlerId.
Add(EventHandlerCreationInformation parameters) EventHandler Adds the EventHandler that is specified by the EventHandlerCreationInformation object to the collection.
GetByGuid(Guid uid) EventHandler Gets a EventHandler from the collection with the Guid value.
GetById(String objectId) EventHandler Gets a EventHandler from the collection with the Id value.
Remove(EventHandler handler) Boolean Removes the specified EventHandler from the collection.
Update() void Updates the event handler collection.


Method Details

'{EventHandlerId}'

Gets a EventHandler from the collection with the specified EventHandlerId.

Syntax
EventHandler http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/EventHandlers('{EventHandlerId}')
Parameters
Name Type Description
EventHandlerId String the id of the EventHandler
Return Value

EventHandler

Add(EventHandlerCreationInformation parameters)

Adds the EventHandler that is specified by the EventHandlerCreationInformation object to the collection.

Syntax
EventHandler Add(EventHandlerCreationInformation parameters)
Parameters
Name Type Description
parameters EventHandlerCreationInformation The properties that can be set when creating a event handler.
Return Value

EventHandler

GetByGuid(Guid uid)

Gets a EventHandler from the collection with the Guid value.

Syntax
EventHandler GetByGuid(Guid uid)
Parameters
Name Type Description
uid Guid The Guid of the EventHandler
Return Value

EventHandler

GetById(String objectId)

Gets a EventHandler from the collection with the Id value.

Syntax
EventHandler GetById(String objectId)
Parameters
Name Type Description
objectId String The id of the EventHandler.
Return Value

EventHandler

Remove(EventHandler handler)

Removes the specified EventHandler from the collection.

Syntax
Boolean Remove(EventHandler handler)
Parameters
Name Type Description
handler EventHandler The EventHandler to remove.
Return Value

Boolean

Update()

Updates the event handler collection.

Syntax
void Update()
Parameters

None

Return Value

void

See Also

EventHandler
EventHandlerCreationInformation
ProjectContext