Class FormEntity

Definition and configuration of a Form

Carrier object for FormEntity. Services for the FormEntity Carrier is available from the IMarketingAgent.

Inheritance

FormEntity

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class FormEntity : Carrier

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Constructors

FormEntity()

Default constructor

Declaration

public FormEntity()

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Properties

Active

Indicates if this form is active or not

Declaration

public virtual bool Active { get; set; }

Property Value

Type	Description
Boolean

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Config

The JSON-formatted config of this form

Declaration

public virtual string Config { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Description

Detailed description

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

EmailFlows

EmailFlows this form is used in (read-only)

Declaration

public virtual int[] EmailFlows { get; set; }

Property Value

Type	Description
Int32[]

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Expires

After this datetime, the form will become inactive

Declaration

public virtual DateTime Expires { get; set; }

Property Value

Type	Description
DateTime

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

FolderId

The folder which this form belongs to. -1 indicates that the shipment is on the root

Declaration

public virtual int FolderId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

FolderName

The name of the folder for this form

Declaration

public virtual string FolderName { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

FormId

Primary key

Declaration

public virtual int FormId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

FormKey

A short string used as unique id to access this form

Declaration

public virtual string FormKey { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

GroupId

The group which this form belongs to.

Declaration

public virtual int GroupId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

MaxSubmits

After this number of submits, the form will become inactive

Declaration

public virtual int MaxSubmits { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Name

The name of this form

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

NewTicket

Indicates if this form creates a ticket or not

Declaration

public virtual bool NewTicket { get; set; }

Property Value

Type	Description
Boolean

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

RecaptchaMode

What is the state of the recaptcha configuration? This is a read-only member

Declaration

public virtual FormsRecaptchaMode RecaptchaMode { get; set; }

Property Value

Type	Description
FormsRecaptchaMode

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Recipe

The JSON-formatted recipe of this form

Declaration

public virtual string Recipe { get; set; }

Property Value

Type	Description
String

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Registered

Registered when in UTC.

Declaration

public virtual DateTime Registered { get; set; }

Property Value

Type	Description
DateTime

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

RegisteredAssociateId

Registered by whom

Declaration

public virtual int RegisteredAssociateId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

ResponseShipmentId

The id of the s_shipment that is used to send the response mails

Declaration

public virtual int ResponseShipmentId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

ScriptId

The CRMScript Macro which will be run when the form is submitted.

Declaration

public virtual int ScriptId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Type

What kind of form is this? Indicates if this is a normal form or a template

Declaration

public virtual FormType Type { get; set; }

Property Value

Type	Description
FormType

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Updated

Last updated when in UTC.

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

UpdatedAssociateId

Last updated by whom

Declaration

public virtual int UpdatedAssociateId { get; set; }

Property Value

Type	Description
Int32

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

UpdatedCount

Number of updates made to this record

Declaration

public virtual short UpdatedCount { get; set; }

Property Value

Type	Description
Int16

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

Examples

Get FormEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var formEntity = agent.GetFormEntity( 123 );
 }

Class FormEntity

Inheritance

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

Examples

Constructors

FormEntity()

Declaration

Examples

See Also

Properties

Active

Declaration

Property Value

Examples

See Also

Config

Declaration

Property Value

Examples

See Also

Description

Declaration

Property Value

Examples

See Also

EmailFlows

Declaration

Property Value

Examples

See Also

Expires

Declaration

Property Value

Examples

See Also

FolderId

Declaration

Property Value

Examples

See Also

FolderName

Declaration

Property Value

Examples

See Also

FormId

Declaration

Property Value

Examples

See Also

FormKey

Declaration

Property Value

Examples

See Also

GroupId

Declaration

Property Value

Examples

See Also

MaxSubmits

Declaration

Property Value

Examples

See Also

Name

Declaration

Property Value

Examples

See Also

NewTicket

Declaration

Property Value

Examples

See Also

RecaptchaMode

Declaration

Property Value