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

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

Interrupts the specified job in the Event Actions job queue.

Namespace: ContentStudio.EventActions
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public void Interrupt(
	ConnectionId connectionId,
	SessionId sessionId,
	int job
)

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
job
Type: SystemInt32
An identifier to the job to interrupt.
Exceptions
ExceptionCondition
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSExceptionPossible CSException types
NumberDescription
2191Job not found. The specified job could not be found.
1022Invalid action. The specified job can not be interrupted since it either running or completed.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
WriteContainer permission on the affected category is required. Users with the GlobalGroupAdmin global right can also successfully call this method.
Remarks

This method is new in Content Studio version 5.2.

This method is used to remove an Event Actions job from the queue.

Note Note
This method can only be used to remove queued jobs, not to stop a currently executing job nor to remove finished, failed or interrupted jobs.
See Also

Reference

EventActionQueue Class
ContentStudio.EventActions Namespace