Interface IRelationAgent

Interface for the Relation Agent Contact/Person relations

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("Relation Agent", "Interface for the Relation Agent. Contact/Person relations")]
public interface IRelationAgent : IAgent

Examples

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   using (RelationAgent agent = new RelationAgent())
   {
      // call methods on agent here...
   }
}

Methods

CreateDefaultContactRelationEntityAsync(CancellationToken)

Loading default values into a new ContactRelationEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

Task<ContactRelationEntity> CreateDefaultContactRelationEntityAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ContactRelationEntity>	New ContactRelationEntity with default values

DeleteContactRelationAsync(int, CancellationToken)

Deletes the spesified contact relation.

Declaration

Task DeleteContactRelationAsync(int contactRelationEntityId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	contactRelationEntityId	Relation to delete
CancellationToken	cancellationToken

Returns

Type	Description
Task

GetContactRelationEntityAsync(int, CancellationToken)

Gets a ContactRelationEntity object.

Declaration

Task<ContactRelationEntity> GetContactRelationEntityAsync(int contactRelationEntityId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	contactRelationEntityId	The identifier of the ContactRelationEntity object
CancellationToken	cancellationToken

Returns

Type	Description
Task<ContactRelationEntity>	ContactRelationEntity

SaveContactRelationAsync(ContactRelationEntity, CancellationToken)

Creates a new or updates an existing contact relation.

Declaration

Task<ContactRelationEntity> SaveContactRelationAsync(ContactRelationEntity contactRelationEntity, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ContactRelationEntity	contactRelationEntity	Relation to save
CancellationToken	cancellationToken

Returns

Type	Description
Task<ContactRelationEntity>	Saved relation