Class Batch

BatchTasks run in the background.

Carrier object for Batch. Services for the Batch Carrier is available from the IBatchAgent.
Inheritance
Object
Batch
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class Batch : Carrier
Examples

Get Batch 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BatchAgent();
    var batch = agent.GetBatch( 123 );
 }

Find all Batch, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("BatchTasks", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

Batch()

Default constructor

Declaration
public Batch()
Examples

Get Batch 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BatchAgent();
    var batch = agent.GetBatch( 123 );
 }

Find all Batch, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("BatchTasks", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get Batch 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BatchAgent();
    var batch = agent.GetBatch( 123 );
 }

Find all Batch, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("BatchTasks", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get Batch 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BatchAgent();
    var batch = agent.GetBatch( 123 );
 }

Find all Batch, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("BatchTasks", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

See Also