Class NSFavouriteAgent

NSFavouriteAgent()

Agent used for retrieving and setting favorites.

Declaration

NSFavouriteAgent

NSFavouriteAgent agent;
agent.callMethod(arg1, arg2);

AddFavourite(String,Integer,Integer,String)

Adds a record in a table as a favorite for an associate

Declaration

Void AddFavourite(String tableName, Integer recordId, Integer associateId, String extraInfo)

Parameters

Returns

AddFavourites(String,Integer[],Integer,String)

Adds a list of record IDs as favorites for an associate

Declaration

Void AddFavourites(String tableName, Integer[] recordIds, Integer associateId, String extraInfo)

Parameters

Returns

GetFavourites(String,Integer)

Gets all favorites for a table and associate

Declaration

NSFavourite[] GetFavourites(String tableName, Integer associateId)

Parameters

Returns

IsFavourite(String,Integer,Integer)

Checks if a record in a table is a favorite for an associate

Declaration

Bool IsFavourite(String tableName, Integer recordId, Integer associateId)

Parameters

Returns

RemoveAllFavourites(String,Integer)

Removes all favorites for a table and associate

Declaration

Void RemoveAllFavourites(String tableName, Integer associateId)

Parameters

Returns

RemoveFavourite(String,Integer,Integer)

Removes favorite for a table, record ID, and associate

Declaration

Void RemoveFavourite(String tableName, Integer recordId, Integer associateId)

Parameters

Returns

RemoveFavouritesById(Integer[])

Removes favorite using favorite ID

Declaration

Void RemoveFavouritesById(Integer[] favoriteIds)

Parameters

Returns

ToggleFavourite(String,Integer,Integer,String)

Toggles a record in a table as a favorite for an associate

Declaration

Bool ToggleFavourite(String tableName, Integer recordId, Integer associateId, String extraInfo)

NSFavouriteAgent agent;
String tableName;
Integer recordId;
Integer associateId;
String extraInfo;
Bool res = agent.ToggleFavourite(tableName, recordId, associateId, extraInfo);

Parameters

Returns