Show / Hide Table of Contents

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 CRMScript Agent.
Inheritance
object
Script
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
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()
See Also
ICRMScriptAgent

Properties

Description

Optional description of what this script is used for.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

IncludeId

A unique name used for including this script in another

Declaration
[DataMember]
public virtual string IncludeId { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Name

A description of this script

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Path

Path to script in the hierarchy.

Declaration
[DataMember]
public virtual string Path { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Registered

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
See Also
ICRMScriptAgent

RegisteredBy

Who created this script

Declaration
[DataMember]
public virtual string RegisteredBy { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Source

The script

Declaration
[DataMember]
public virtual string Source { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

UniqueIdentifier

Global unique identifier, accross customers/tenants

Declaration
[DataMember]
public virtual string UniqueIdentifier { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Updated

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
See Also
ICRMScriptAgent

UpdatedBy

Who updated this script

Declaration
[DataMember]
public virtual string UpdatedBy { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
ICRMScriptAgent

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.

See Also
ICRMScriptAgent

See Also

ICRMScriptAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top