EventActionQueueAddJob Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Adds a new external asynchronous event actions job to the queue.

Namespace: ContentStudio.EventActions
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public int AddJob(
	ConnectionId connectionId,
	SessionId sessionId,
	ContentStudioEvents csEvent,
	TimeSpan runAfter,
	string affectedItemId,
	string affectedItemName,
	string moniker
)

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 typically is retrieved from a call to the OpenSession method
csEvent
Type: ContentStudio.EventActionsContentStudioEvents
The event type.
runAfter
Type: SystemTimeSpan
Specifies how long the item should be queued before the ServiceManager is allowed to pick it up again. This value cannot be negative.
affectedItemId
Type: SystemString
The affected item identifier.
affectedItemName
Type: SystemString
Name of the affected item.
moniker
Type: SystemString
The moniker to use. The moniker is used to indicate to the Service Manager how to create an external event actions handler instance. To create a .NET object you can use its fully qualified name e.g. "MyEventHandlers.OnDocumentDeleteHandler, MyEventHandlers"

Return Value

Type: Int32
The identifier of the queue item
Exceptions
ExceptionCondition
ArgumentNullException moniker or affectedItemId
ArgumentOutOfRangeException moniker;Value cannot be empty or affectedItemId;Value cannot be empty or runAfter;Value cannot be negative
CSInvalidSessionException
CSPermissionDeniedException
SqlException
Content Studio permissions
Callers with the WRITEEVENTACTIONQUEUE permission on the EventActions root or having the GlobalGroupAdmin or ServiceQueueAdmin global right can successfully call this method.
Remarks

This method was added in Content Studio 5.7 update 1.

External services can add their own asynchronous events in order to use the Event actions infrastructure.

External jobs will be placed in the standard category System/App_Data and the events can be monitored by reading data using the GetListPageable(ConnectionId, SessionId, NullableCategoryId, ServiceManagerJobStatusValue, Int32, Int32) method with the id of that category (93) as an argument.

See Also

Reference

EventActionQueue Class
ContentStudio.EventActions Namespace