SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
erminas.SmartAPI.CMS.Project.IAsyncJob Interface Reference
+ Inheritance diagram for erminas.SmartAPI.CMS.Project.IAsyncJob:
+ Collaboration diagram for erminas.SmartAPI.CMS.Project.IAsyncJob:

Public Member Functions

void RunAsync ()
 Run this job asynchronously. If you need to wait for the job to finish, use RunSync instead.
 
void RunSync (TimeSpan maxWait)
 Run this job and wait until it is finished. Jobs can take some time, so make sure you have a large enough maxWait for your server to finish.
 

Properties

string EmailMessage [get, set]
 
IUser EmailReceipient [get, set]
 
string EmailSubject [get, set]
 
bool IsSendingEmailOnCompletion [get, set]
 
IApplicationServer Server [get, set]
 
- Properties inherited from erminas.SmartAPI.CMS.ISessionObject
ISession Session [get]
 

Detailed Description

Definition at line 22 of file IAsyncProjectJob.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.IAsyncJob.RunAsync ( )

Run this job asynchronously. If you need to wait for the job to finish, use RunSync instead.

void erminas.SmartAPI.CMS.Project.IAsyncJob.RunSync ( TimeSpan  maxWait)

Run this job and wait until it is finished. Jobs can take some time, so make sure you have a large enough maxWait for your server to finish.

Exceptions
TimeoutExceptionThrown, if the copy job wasn't finished in time

Property Documentation

string erminas.SmartAPI.CMS.Project.IAsyncJob.EmailMessage
getset

Definition at line 24 of file IAsyncProjectJob.cs.

IUser erminas.SmartAPI.CMS.Project.IAsyncJob.EmailReceipient
getset

Definition at line 25 of file IAsyncProjectJob.cs.

string erminas.SmartAPI.CMS.Project.IAsyncJob.EmailSubject
getset

Definition at line 26 of file IAsyncProjectJob.cs.

bool erminas.SmartAPI.CMS.Project.IAsyncJob.IsSendingEmailOnCompletion
getset

Definition at line 27 of file IAsyncProjectJob.cs.

IApplicationServer erminas.SmartAPI.CMS.Project.IAsyncJob.Server
getset

Definition at line 41 of file IAsyncProjectJob.cs.


The documentation for this interface was generated from the following file: