Class AssociateAgent

Proxy class for the Associate Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance
object
AssociateAgent
Implements
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.Implementation.dll
Syntax
public class AssociateAgent : IAssociateAgent, IAgent

Constructors

AssociateAgent(IAssociateImplementation, IAssociateListImplementation, ISoRequestItemsAccessor)

Proxy class for the Associate Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public AssociateAgent(IAssociateImplementation associateImplementation, IAssociateListImplementation associateListImplementation, ISoRequestItemsAccessor accessor)
Parameters
Type Name Description
IAssociateImplementation associateImplementation
IAssociateListImplementation associateListImplementation
ISoRequestItemsAccessor accessor

AssociateAgent(IAssociateImplementation, IAssociateListImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the Associate Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public AssociateAgent(IAssociateImplementation associateImplementation, IAssociateListImplementation associateListImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)
Parameters
Type Name Description
IAssociateImplementation associateImplementation
IAssociateListImplementation associateListImplementation
ISoRequestItemsAccessor accessor
IDebugUser debugUser
IServiceCallsRepository serviceCallsRepository
IScriptingConfiguration scriptingConfiguration
IOnlineConfiguration onlineConfiguration

Methods

GetAssociateAsync(int, CancellationToken)

Gets a Associate object.

Declaration
public Task<Associate> GetAssociateAsync(int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

The identifier of the Associate object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Associate>

A single Associate

GetAssociateByPersonIdAsync(int, CancellationToken)

Returns the associate that belongs to this person if the person is an associate.

Declaration
public Task<Associate> GetAssociateByPersonIdAsync(int personId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId

The person id
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Associate>

Associate if person is associate

GetAssociateListAsync(int[], CancellationToken)

Gets an array of Associate objects.

Declaration
public Task<Associate[]> GetAssociateListAsync(int[] associateIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] associateIds

The identifiers of the Associate object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Associate[]>

Array of Associate

GetAssociatesByGroupAsync(int, int, CancellationToken)

Method that returns a array of associate , based on DiaryGroupType and groupId. The differernt types are, Userdefined, Usergroup and ResourceHeadings

Declaration
public Task<Associate[]> GetAssociatesByGroupAsync(int groupId, int type, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int groupId

Id of the group
int type

The type of group. See DiaryGroupType
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Associate[]>

Array of associate

GetEncryptionKeyAsync(CancellationToken)

Get unique key made from AssociateId and dbTag used for local storage encryption operations.

Declaration
public Task<string> GetEncryptionKeyAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<string>

encryptionKey

GetNoteAsync(int, CancellationToken)

Returns an array of strings(notepad pages).

Declaration
public Task<string[]> GetNoteAsync(int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

The associate id
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<string[]>

Returns an array of strings(notepad pages).

LogOffWindowsUsersAsync(int[], CancellationToken)

Method that logs off associates that are logged on to the win client

Declaration
public Task LogOffWindowsUsersAsync(int[] associateIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] associateIds

The ids of the associates that shall be logged off
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

A void return

SaveNoteAsync(int, string[], CancellationToken)

Saves an array of strings(notepad pages).

Declaration
public Task SaveNoteAsync(int associateId, string[] note, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

The associate id
string[] note

The array of strings(notepad pages).
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

Implements