Class RelationAgent
Proxy class for the Relation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.Implementation.dll
Syntax
public class RelationAgent : IRelationAgent, IAgent
Constructors
RelationAgent(IContactRelationEntityImplementation, ISoRequestItemsAccessor)
Proxy class for the Relation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Declaration
public RelationAgent(IContactRelationEntityImplementation contactRelationEntityImplementation, ISoRequestItemsAccessor accessor)
Parameters
| Type | Name | Description |
|---|---|---|
| IContactRelationEntityImplementation | contactRelationEntityImplementation | |
| ISoRequestItemsAccessor | accessor |
RelationAgent(IContactRelationEntityImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)
Proxy class for the Relation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Declaration
public RelationAgent(IContactRelationEntityImplementation contactRelationEntityImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)
Parameters
| Type | Name | Description |
|---|---|---|
| IContactRelationEntityImplementation | contactRelationEntityImplementation | |
| ISoRequestItemsAccessor | accessor | |
| IDebugUser | debugUser | |
| IServiceCallsRepository | serviceCallsRepository | |
| IScriptingConfiguration | scriptingConfiguration | |
| IOnlineConfiguration | onlineConfiguration |
Methods
CreateDefaultContactRelationEntityAsync(CancellationToken)
Loading default values into a new ContactRelationEntity.
Declaration
public Task<ContactRelationEntity> CreateDefaultContactRelationEntityAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task<ContactRelationEntity> | New ContactRelationEntity with default values |
DeleteContactRelationAsync(int, CancellationToken)
Deletes the spesified contact relation.
Declaration
public Task DeleteContactRelationAsync(int contactRelationEntityId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | contactRelationEntityId | Relation to delete |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task |
GetContactRelationEntityAsync(int, CancellationToken)
Gets a ContactRelationEntity object.
Declaration
public Task<ContactRelationEntity> GetContactRelationEntityAsync(int contactRelationEntityId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | contactRelationEntityId | The identifier of the ContactRelationEntity object |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task<ContactRelationEntity> | A single ContactRelationEntity |
SaveContactRelationAsync(ContactRelationEntity, CancellationToken)
Creates a new or updates an existing contact relation.
Declaration
public Task<ContactRelationEntity> SaveContactRelationAsync(ContactRelationEntity contactRelationEntity, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ContactRelationEntity | contactRelationEntity | Relation to save |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task<ContactRelationEntity> | Saved relation |