Show / Hide Table of Contents

Class ResourceEntity

The resource entity contains resource information

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }

Constructors

ResourceEntity()

Default constructor

Declaration
public ResourceEntity()
Examples

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

Properties

Deleted

If true, the resource is deleted.

Declaration
public virtual bool Deleted { get; set; }
Property Value
Type Description
Boolean
Examples

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

IsLocation

If true the resource is a location

Declaration
public virtual bool IsLocation { get; set; }
Property Value
Type Description
Boolean
Examples

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

LocationAddress

Address of location, if this is a resource that is a location

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

Name

Initials, also login name, possibly database user name

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

Rank

Rank order

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

ResourceId

Primary key

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

Tooltip

Tooltip or other description

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

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

Examples

Get ResourceEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var resourceEntity = agent.GetResourceEntity( 123 );
 }
See Also
ListAgent
IListAgent

See Also

ListAgent
IListAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top