Class Script

The Script Service. The service implements all services working with the CRMScript object without reference to primary keys. Primarily used by VSCode integration.

Carrier object for Script. Services for the Script Carrier is available from the ICRMScriptAgent.

Inheritance

Object

Script

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class Script : Carrier

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

Constructors

Script()

Default constructor

Declaration

public Script()

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

Description

Optional description of what this script is used for.

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

IncludeId

A unique name used for including this script in another

Declaration

public virtual string IncludeId { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Name

A description of this script

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Path

Path to script in the hierarchy.

Declaration

public virtual string Path { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Registered

Registered when in UTC.

Declaration

public virtual DateTime Registered { get; set; }

Property Value

Type	Description
DateTime

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RegisteredBy

Who created this script

Declaration

public virtual string RegisteredBy { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Source

The script

Declaration

public virtual string Source { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UniqueIdentifier

Global unique identifier, accross customers/tenants

Declaration

public virtual string UniqueIdentifier { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Updated

Last updated when in UTC.

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedBy

Who updated this script

Declaration

public virtual string UpdatedBy { get; set; }

Property Value

Type	Description
String

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

Examples

Get Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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 Script 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var script = agent.GetScript( 123 );
 }

Find all Script, get related items using archive agent.

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

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)