EventActions.GetList Method (ConnectionId, SessionId, CategoryId)

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)

Syntax

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

Public Function GetList ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId
) As String

Parameters

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

Return Value

Type: String
Xml

Copy

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <eventaction>
    <EAID>1000</EAID>
    <name>When a document is pulbished</name>
    <enabled>1</enabled>
    <eventid>8</eventid>
    <actiontype>0</actiontype>
    <order>0</order>
    <command>http://teknikhuset.se/</command>
    <runonce>0</runonce>
    <timeout>0</timeout>
    <lastrun>2009-07-01T17:41:48.763</lastrun>
    <moniker></moniker>
    <unique>0</unique>
    <eventname>OnDocumentPublish</eventname>
  </eventaction>
  <!--More eventaction nodes can follow -->
</root>

Xml nodes and meaning

Node	Description
root/status	Integer: Indicates the outcome of the call. Always 0 which is success.
root/statustext	String: Indicates the textual outcome of the call. Always 'Success'
root/eventaction	Defines a single event actions definition.
root/eventaction/EAID	Integer: The internal identifier of the event action definition.
root/eventaction/name	String: The name of the event action definition, e.g. "My first event"
root/eventaction/enabled	Bit (0 or 1): 1 when the event definition is enabled; otherwise, 0.
root/eventaction/eventid	Integer: A value that identifies the type of event. For more information see ContentStudioEvents.
root/eventaction/actiontype	Integer: Specifies the type of action e.g. 'AsynEventHandlerObject' or 'EventHandlerObject'. For more information see ActionTypes.
root/eventaction/order	Integer: The execution order, a lower value is executed before a higher value.
root/eventaction/command	String: The command to execute. The syntax for the command is depending on the ActionType.
root/eventaction/runonce	Bit (0 or 1): 1 when the action will run only once; otherwise, 0.
root/eventaction/lastrun	DateTime: Indicates when the event last was executed.
root/eventaction/moniker	The 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/unique	Bit (0 or 1): 1 if only one definition if a specific event type can exists on the category; otherwise, 0.
root/eventaction/eventname	The name of the type of event, i.e. the textual version of the eventid value, e.g. OnDocumentPublish

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the event action category item is required

Reference

EventActions Class

GetList Overload

ContentStudio.EventActions Namespace