EventActionsGetList Method (ConnectionId, SessionId, CategoryId) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a list of event action definitions for a certain category. The list is returned in execute order.

Namespace: ContentStudio.EventActions
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetList(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: ContentStudio.DocumentCategoryId
The identifier to the category to list event actions items from.

Return Value

Type: String
    <name>When a document is pulbished</name>
  <!--More eventaction nodes can follow -->
Xml nodes and meaning
root/statusInteger: Indicates the outcome of the call. Always 0 which is success.
root/statustextString: Indicates the textual outcome of the call. Always 'Success'
root/eventactionDefines a single event actions definition.
root/eventaction/EAIDInteger: The internal identifier of the event action definition.
root/eventaction/nameString: The name of the event action definition, e.g. "My first event"
root/eventaction/enabledBit (0 or 1): 1 when the event definition is enabled; otherwise, 0.
root/eventaction/eventidInteger: A value that identifies the type of event. For more information see ContentStudioEvents.
root/eventaction/actiontypeInteger: Specifies the type of action e.g. 'AsynEventHandlerObject' or 'EventHandlerObject'. For more information see ActionTypes.
root/eventaction/orderInteger: The execution order, a lower value is executed before a higher value.
root/eventaction/commandString: The command to execute. The syntax for the command is depending on the ActionType.
root/eventaction/runonceBit (0 or 1): 1 when the action will run only once; otherwise, 0.
root/eventaction/lastrunDateTime: Indicates when the event last was executed.
root/eventaction/monikerThe moniker to use. The moniker is used to indicate to the Service Manager or Content Studio how or where the event should be directed. Depending on the action this can be a URL or a moniker used to create an external object. To create a .NET object you can use its fully qualified name e.g. "SyncEventHandler.OnDocumentDeleteHandler, SyncEventHandler"
root/eventaction/uniqueBit (0 or 1): 1 if only one definition if a specific event type can exists on the category; otherwise, 0.
root/eventaction/eventnameThe name of the type of event, i.e. the textual version of the eventid value, e.g. OnDocumentPublish

CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

READ permission on the event action category item is required
See Also