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