Interface IAssociateAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Associate utilities, notes, not user admininstration
Implements
IAgentBase, IDisposableMethods
GetAssociateAsync(int, RequestOptions)
Gets a specific Associate object.Parameters
associateId int
The identifier of the Associate object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Associate> AssociateGetAssociateByPersonIdAsync(int, RequestOptions)
Returns the associate that belongs to this person if the person is an associate.Parameters
personId int
The person id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Associate> Associate if person is associateGetAssociateListAsync(int[], RequestOptions)
Gets an array of specific Associate objects.Parameters
associateIds int[]
The identifiers of the Associate object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Associate[]> Array of Associate objectsGetAssociatesByGroupAsync(int, int, RequestOptions)
Method that returns a array of associate , based on DiaryGroupType and groupId. The differernt types are, Userdefined, Usergroup and ResourceHeadingsParameters
groupId int
Id of the group
type int
The type of group. See DiaryGroupType
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Associate[]> Array of associateGetEncryptionKeyAsync(RequestOptions)
Get unique key made from AssociateId and dbTag used for local storage encryption operations.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> encryptionKeyGetNoteAsync(int, RequestOptions)
Returns an array of strings(notepad pages).Parameters
associateId int
The associate id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string[]> Returns an array of strings(notepad pages).LogOffWindowsUsersAsync(int[], RequestOptions)
Method that logs off associates that are logged on to the win clientParameters
associateIds int[]
The ids of the associates that shall be logged off
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task A void returnSaveNoteAsync(int, string[], RequestOptions)
Saves an array of strings(notepad pages).Parameters
associateId int
The associate id
note string[]
The array of strings(notepad pages).
requestOptions RequestOptions
Override language/culture codes on this request.