Class FormEntity

Definition and configuration of a Form

Carrier object for FormEntity. Services for the FormEntity Carrier is available from the Marketing Agent.
Inheritance
object
FormEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
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()
See Also

Properties

Active

Indicates if this form is active or not

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

Config

The JSON-formatted config of this form

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

Description

Detailed description

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

EmailFlows

EmailFlows this form is used in (read-only)

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

Expires

After this datetime, the form will become inactive

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

FolderId

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

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

FolderName

The name of the folder for this form

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

FormId

Primary key

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

FormKey

A short string used as unique id to access this form

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

GroupId

The group which this form belongs to.

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

MaxSubmits

After this number of submits, the form will become inactive

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

Name

The name of this form

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

NewTicket

Indicates if this form creates a ticket or not

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

RecaptchaMode

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

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

Recipe

The JSON-formatted recipe of this form

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

Registered

Registered when in UTC.

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

RegisteredAssociateId

Registered by whom

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

ResponseShipmentId

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

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

ScriptId

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

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

Type

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

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

Updated

Last updated when in UTC.

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

UpdatedAssociateId

Last updated by whom

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

UpdatedCount

Number of updates made to this record

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
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.
See Also

See Also