Class AudienceLayoutEntity

Audience layout. Each instance of Audience has at least one layout. The layout is connected to the instance by it's instance name or is linked to the currently logged on user. The web part layout and the Audience configuration parameters belongs to an Audience layout

Carrier object for AudienceLayoutEntity. Services for the AudienceLayoutEntity Carrier is available from the IAudienceAgent.
Inheritance
Object
AudienceLayoutEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class AudienceLayoutEntity : Carrier
Examples

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }

Constructors

AudienceLayoutEntity()

Default constructor

Declaration
public AudienceLayoutEntity()
Examples

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

Properties

AudienceLayoutId

The Id of the Audience layout

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

CreatedBy

Name of the person that created the Audience layout

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

CreatedDate

The date and time the Audience layout was created in UTC.

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

InstanceLayout

The web part layout as a serialized string

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

InstanceName

Name of the layout instance

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

UpdatedBy

Name of the person that last updated the Audience layout

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

UpdatedDate

The date and time the Audience layout was last updated in UTC.

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

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
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.
Examples

Get AudienceLayoutEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AudienceAgent();
    var audienceLayoutEntity = agent.GetAudienceLayoutEntity( 123 );
 }
See Also

See Also