Class NSFavouriteAgent
Agent used for retrieving and setting favorites.
Syntax
Examples
NSFavouriteAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSFavouriteAgent()
Agent used for retrieving and setting favorites.
Introduced or updated in version: 8.0sr3
Declaration
NSFavouriteAgentExamples
NSFavouriteAgent agent;
agent.callMethod(arg1, arg2);Methods
AddFavourite(String,Integer,Integer,String)
Adds a record in a table as a favorite for an associate
Introduced or updated in version: 8.0sr3
Declaration
Void AddFavourite(String tableName, Integer recordId, Integer associateId, String extraInfo)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | recordId | |
| Integer | associateId | |
| String | extraInfo |
Returns
| Type | Description |
|---|---|
| Void |
AddFavourites(String,Integer[],Integer,String)
Adds a list of record IDs as favorites for an associate
Introduced or updated in version: 8.0sr3
Declaration
Void AddFavourites(String tableName, Integer[] recordIds, Integer associateId, String extraInfo)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer[] | recordIds | |
| Integer | associateId | |
| String | extraInfo |
Returns
| Type | Description |
|---|---|
| Void |
GetFavourites(String,Integer)
Gets all favorites for a table and associate
Introduced or updated in version: 8.0sr3
Declaration
NSFavourite[] GetFavourites(String tableName, Integer associateId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | associateId |
Returns
| Type | Description |
|---|---|
| NSFavourite[] |
IsFavourite(String,Integer,Integer)
Checks if a record in a table is a favorite for an associate
Introduced or updated in version: 8.0sr3
Declaration
Bool IsFavourite(String tableName, Integer recordId, Integer associateId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | recordId | |
| Integer | associateId |
Returns
| Type | Description |
|---|---|
| Bool |
RemoveAllFavourites(String,Integer)
Removes all favorites for a table and associate
Introduced or updated in version: 8.0sr3
Declaration
Void RemoveAllFavourites(String tableName, Integer associateId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | associateId |
Returns
| Type | Description |
|---|---|
| Void |
RemoveFavourite(String,Integer,Integer)
Removes favorite for a table, record ID, and associate
Introduced or updated in version: 8.0sr3
Declaration
Void RemoveFavourite(String tableName, Integer recordId, Integer associateId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | recordId | |
| Integer | associateId |
Returns
| Type | Description |
|---|---|
| Void |
RemoveFavouritesById(Integer[])
Removes favorite using favorite ID
Introduced or updated in version: 8.0sr3
Declaration
Void RemoveFavouritesById(Integer[] favoriteIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer[] | favoriteIds |
Returns
| Type | Description |
|---|---|
| Void |
ToggleFavourite(String,Integer,Integer,String)
Toggles a record in a table as a favorite for an associate
Introduced or updated in version: 8.0sr3
Declaration
Bool ToggleFavourite(String tableName, Integer recordId, Integer associateId, String extraInfo)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | recordId | |
| Integer | associateId | |
| String | extraInfo |
Returns
| Type | Description |
|---|---|
| Bool | true if added; false if removed. |
Examples
NSFavouriteAgent agent;
String tableName;
Integer recordId;
Integer associateId;
String extraInfo;
Bool res = agent.ToggleFavourite(tableName, recordId, associateId, extraInfo);