Class RoleEntity

Carrier object for RoleEntity. Services for the RoleEntity Carrier is available from the IUserAgent.

Inheritance

RoleEntity

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class RoleEntity : Carrier

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Constructors

RoleEntity()

Default constructor

Declaration

public RoleEntity()

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Properties

Created

Registered when in UTC.

Declaration

public virtual DateTime Created { get; set; }

Property Value

Type	Description
DateTime

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

CreatedBy

Created by user

Declaration

public virtual Associate CreatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

DataRights

Data rights matrix - defines role's access to data owned by current user, users in same group, and other users.

Declaration

public virtual DataRights DataRights { get; set; }

Property Value

Type	Description
DataRights

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Deleted

1 if role has been deleted (we do not actually delete)

Declaration

public virtual short Deleted { get; set; }

Property Value

Type	Description
Int16

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Name

Visible role name

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Rank

Sorting rank of this role in lists

Declaration

public virtual short Rank { get; set; }

Property Value

Type	Description
Int16

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

RoleId

Primary key

Declaration

public virtual int RoleId { get; set; }

Property Value

Type	Description
Int32

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

RoleType

The role type. Note that changing this field has no effect, so treat this as a read-only field.

Declaration

public virtual RoleType RoleType { get; set; }

Property Value

Type	Description
RoleType

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Declaration

public virtual string Tooltip { get; set; }

Property Value

Type	Description
String

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

UserAgent

IUserAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Updated

Last updated when in UTC.

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

UpdatedBy

Last updated by user

Declaration

public virtual Associate UpdatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

UseCategories

Apply role category membership to users

Declaration

public virtual short UseCategories { get; set; }

Property Value

Type	Description
Int16

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

Examples

Get RoleEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var roleEntity = agent.GetRoleEntity( 123 );
 }

Find all RoleEntity, get related items using archive agent.

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

Class RoleEntity

Inheritance

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

Examples

Constructors

RoleEntity()

Declaration

Examples

See Also

Properties

Created

Declaration

Property Value

Examples

See Also

CreatedBy

Declaration

Property Value

Examples

See Also

DataRights

Declaration

Property Value

Examples

See Also

Deleted

Declaration

Property Value

Examples

See Also

Name

Declaration

Property Value

Examples

See Also

Rank

Declaration

Property Value

Examples

See Also

RoleId

Declaration

Property Value

Examples

See Also

RoleType

Declaration

Property Value

Examples

See Also

Tooltip

Declaration

Property Value

Examples

See Also

Updated

Declaration

Property Value

Examples

See Also

UpdatedBy

Declaration

Property Value

Examples

See Also

UseCategories

Declaration

Property Value

Examples

See Also

Methods

ToString()

Declaration

Returns

Examples

See Also

ToString(String)

Declaration