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

EventHandlerCollection class

Nadin Merali|Last Updated: 5/6/2017

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.NETJSOMRESTTypeDescription
[Integer]EventHandlerGets a EventHandler from the collection at the specified index.
ItemEventHandlerGets a EventHandler from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{EventHandlerId}'EventHandlerGets a EventHandler from the collection with the specified EventHandlerId.
Add(EventHandlerCreationInformation parameters)EventHandlerAdds the EventHandler that is specified by the EventHandlerCreationInformation object to the collection.
GetByGuid(Guid uid)EventHandlerGets a EventHandler from the collection with the Id value.
GetById(String objectId)EventHandlerGets a EventHandler from the collection with the Guid value.
Remove(EventHandler handler)BooleanRemoves the specified EventHandler from the collection.
Update()voidUpdates 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
NameTypeDescription
EventHandlerIdStringthe 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
NameTypeDescription
parametersEventHandlerCreationInformationThe properties that can be set when creating a event handler.
Return Value

EventHandler

GetByGuid(Guid uid)

Gets a EventHandler from the collection with the Id value.

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

EventHandler

GetById(String objectId)

Gets a EventHandler from the collection with the Guid value.

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

EventHandler

Remove(EventHandler handler)

Removes the specified EventHandler from the collection.

Syntax
Boolean Remove(EventHandler handler)
Parameters
NameTypeDescription
handlerEventHandlerThe 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

© 2018 Microsoft