NSFavouriteAgent - SuperOffice

Agent used for retrieving and setting favorites.

Constructors

NSFavouriteAgent()

NSFavouriteAgent

Agent used for retrieving and setting favorites.

Methods

AddFavourite(String,Integer,Integer,String)

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

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

Returns: CRMScript.Global.Void

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

Adds a list of record IDs as favorites for an associate

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

Returns: CRMScript.Global.Void

GetFavourites(String,Integer)

Gets all favorites for a table and associate

NSFavourite[] GetFavourites(String tableName, Integer associateId)

Returns: CRMScript.NetServer.NSFavourite[]

IsFavourite(String,Integer,Integer)

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

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

Returns: CRMScript.Global.Bool

RemoveAllFavourites(String,Integer)

Removes all favorites for a table and associate

Void RemoveAllFavourites(String tableName, Integer associateId)

Returns: CRMScript.Global.Void

RemoveFavourite(String,Integer,Integer)

Removes favorite for a table, record ID, and associate

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

Returns: CRMScript.Global.Void

RemoveFavouritesById(Integer[])

Removes favorite using favorite ID

Void RemoveFavouritesById(Integer[] favoriteIds)

Returns: CRMScript.Global.Void

ToggleFavourite(String,Integer,Integer,String)

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

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

Returns: CRMScript.Global.Bool - true if added; false if removed. Example:

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

​Constructors

​NSFavouriteAgent()

​Methods

​AddFavourite(String,Integer,Integer,String)

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

​GetFavourites(String,Integer)

​IsFavourite(String,Integer,Integer)

​RemoveAllFavourites(String,Integer)

​RemoveFavourite(String,Integer,Integer)

​RemoveFavouritesById(Integer[])

​ToggleFavourite(String,Integer,Integer,String)

Constructors

NSFavouriteAgent()

Methods

AddFavourite(String,Integer,Integer,String)

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

GetFavourites(String,Integer)

IsFavourite(String,Integer,Integer)

RemoveAllFavourites(String,Integer)

RemoveFavourite(String,Integer,Integer)

RemoveFavouritesById(Integer[])

ToggleFavourite(String,Integer,Integer,String)