Show / Hide Table of Contents

Class SystemEventEntity

Entity for system events

Carrier object for SystemEventEntity. Services for the SystemEventEntity Carrier is available from the Configuration Agent.
Inheritance
object
SystemEventEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class SystemEventEntity : Carrier
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Constructors

SystemEventEntity()

Default constructor

Declaration
public SystemEventEntity()
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Properties

ActivatedBy

The associate that first created the SystemEvent.

Declaration
public virtual Associate ActivatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Eta

Estimated Time of Arrival, i.e., when will this event finish?

Declaration
public virtual DateTime Eta { get; set; }
Property Value
Type Description
DateTime
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Eventkey

Event key, predefined in code

Declaration
public virtual string Eventkey { get; set; }
Property Value
Type Description
String
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Eventmess

Message to be shown, entered by administrator

Declaration
public virtual string Eventmess { get; set; }
Property Value
Type Description
String
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

ExtraInfo

Extra information (area id for prototype rebuild, etc)

Declaration
public virtual int ExtraInfo { get; set; }
Property Value
Type Description
Int32
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Owner

0, 0, group_id, assoc id (see over)

Declaration
public virtual int Owner { get; set; }
Property Value
Type Description
Int32
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SystemEvents", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also
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 SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

Scope

1 = system-wide, 2= database, 3 = group, 4 = user

Declaration
public virtual SystemEventScope Scope { get; set; }
Property Value
Type Description
SystemEventScope
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

SystemEventId

Primary key

Declaration
public virtual int SystemEventId { get; set; }
Property Value
Type Description
Int32
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

UpdatedCount

Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Examples

Get SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SystemEvents", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also
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 SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SystemEvents", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also
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 SystemEventEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ConfigurationAgent();
    var systemEventEntity = agent.GetSystemEventEntity( 123 );
 }

Find all SystemEventEntity, get related items using archive agent.

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

See Also

ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top