Show / Hide Table of Contents

Class ContactRelationEntity

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the Relation Agent.
Inheritance
object
ContactRelationEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
public class ContactRelationEntity : Carrier
Examples

Get ContactRelationEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new RelationAgent();
   var contactRelationEntity = agent.GetContactRelationEntity( 123 );
}

Find all ContactRelationEntity, get related items using archive agent.

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

Constructors

ContactRelationEntity()

Default constructor

Declaration
public ContactRelationEntity()
See Also
IRelationAgent

Properties

ActiveText

Active text for the relation.

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

Comment

Comment for relation

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

CreatedBy

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the Relation Agent.
Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also
IRelationAgent

CreatedDate

Registered when in UTC.

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

DestinationContactId

Id of the destination contact. The value is mandatory.

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

DestinationContactName

Name of the destination contact.

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

DestinationPersonId

Id of the destination person. The value is not mandatory. The person must belong to the destination contact.

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

DestinationPersonName

Name of the destination person.

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

PassiveText

Passive text for the relation.

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

RelationDefinitionId

Reference to definition

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

RelationId

Primary key

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

Reversed

Is direction reversed relative to definition

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

SourceContactId

Id of the source contact. The value is mandatory.

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

SourceContactName

Name of the source contact.

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

SourcePersonId

Id of the source person. The value is not mandatory. The person must belong to the source contact.

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

SourcePersonName

Name of the source person.

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

UpdatedBy

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the Relation Agent.
Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also
IRelationAgent

UpdatedDate

Last updated when in UTC.

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IRelationAgent

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
IRelationAgent

See Also

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