Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
[This is preliminary documentation and is subject to change.]
Performs a user action against the Workflow server.
Namespace: ContentStudio.Document.Workflow
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void PerformUserAction( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, WorkflowActions action, string workflowComment, string workflowStepname, DateTime workflowDueDate, string newOwnerSId, string membersXml )
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). - documentId
- Type: ContentStudio.DocumentDocumentId
The document to perform action for - action
- Type: ContentStudio.Document.WorkflowWorkflowActions
The action to perform. The following actions is not supported: CheckIn, CheckOut, Delete, Restore. Those actions should be performed using the ordinary methods. - workflowComment
- Type: SystemString
A comment regarding this action - workflowStepname
- Type: SystemString
The name of a workflow step to perform - workflowDueDate
- Type: SystemDateTime
The workflow due data. Pass DataTime.MaxValue to indicate an value not in use. - newOwnerSId
- Type: SystemString
A new SID to set (ignored unless Action is ChangeWFOwner - membersXml
- Type: SystemString
Xml that contains definitions for new members in the active step. Ignored unless Action is SetParticipants
Exceptions
Exception | Condition |
---|---|
InvalidOperationException | Both the DocumentID and the CategoryID arguments cannot be zero. |
ArgumentOutOfRangeException | An invalid action for this method was used. Use the ordinary method to perform the corresponding action (Approve, CheckIn, CheckOut, Delete, Restore, TerminateWorkflow) |
CSException | A workflow rule was violated. |
XmlException | Invalid xml was supplied internally. |
See Also