Class NSAssociateAgent
Associate utilities, notes, not user administration.
Syntax
Examples
NSAssociateAgent agent;
agent.callMethod(arg1, arg2);
Constructors
NSAssociateAgent()
Associate utilities, notes, not user administration.
Declaration
Examples
NSAssociateAgent agent;
agent.callMethod(arg1, arg2);
Methods
GetAssociate(Integer)
Gets an NSAssociate object.
Declaration
NSAssociate GetAssociate(Integer associateId)
Parameters
| Type |
Name |
Description |
| Integer |
associateId |
|
Returns
Examples
NSAssociateAgent agent;
NSAssociate thing = agent.GetAssociate(123);
GetAssociateByPersonId(Integer)
Returns the associate that belongs to this person if the person is an associate.
Declaration
NSAssociate GetAssociateByPersonId(Integer personId)
Parameters
| Type |
Name |
Description |
| Integer |
personId |
|
Returns
| Type |
Description |
| NSAssociate |
The associate that belongs to this person if the person is an associate.
|
Examples
NSAssociateAgent agent;
Integer personId;
NSAssociate res = agent.GetAssociateByPersonId(personId);
GetAssociateList(Integer[])
Retrieves a list of associates.
Declaration
NSAssociate[] GetAssociateList(Integer[] associateIds)
Parameters
| Type |
Name |
Description |
| Integer[] |
associateIds |
|
Returns
Examples
Integer[] ids;
NSAssociateAgent agent;
agent.GetAssociateList(ids);
GetAssociatesByGroup(Integer,Integer)
Returns a array of associate based on DiaryGroupType and groupId.
Declaration
NSAssociate[] GetAssociatesByGroup(Integer groupId, Integer type)
Parameters
| Type |
Name |
Description |
| Integer |
groupId |
|
| Integer |
type |
The different types are Userdefined, Usergroup, and ResourceHeadings.
|
Returns
Examples
NSAssociateAgent agent;
Integer groupId;
Integer type;
NSAssociate[] res = agent.GetAssociatesByGroup(groupId, type);
GetNote(Integer)
Returns an array of strings(notepad pages).
Declaration
String[] GetNote(Integer associateId)
Parameters
| Type |
Name |
Description |
| Integer |
associateId |
|
Returns
Examples
NSAssociateAgent agent;
Integer associateId;
String[] res = agent.GetNote(associateId);
LogOffWindowsUsers(Integer[])
Logs off associates that are logged on to the Win client
Declaration
Void LogOffWindowsUsers(Integer[] associateIds)
Parameters
| Type |
Name |
Description |
| Integer[] |
associateIds |
|
Returns
Examples
NSAssociateAgent agent;
Integer[] associateIds;
agent.LogOffWindowsUsers(associateIds);
SaveNote(Integer,String[])
Saves an array of strings(notepad pages).
Declaration
Void SaveNote(Integer associateId, String[] note)
Parameters
Returns
Examples
NSAssociateAgent agent;
agent.callMethod(arg1, arg2);