Class NSHistory

The usage history of the currently logged in user is represented as History objects.

Constructors

NSHistory()

Initializes a new instance of the NSHistory class.

Declaration

NSHistory

Methods

GetAssociateId()

Declaration

Integer GetAssociateId()

Examples

NSHistory thing;
Integer associateId = thing.GetAssociateId();

Returns

Type	Description
Integer	Owner of history list.

GetHistoryId()

Declaration

Integer GetHistoryId()

Examples

NSHistory thing;
Integer historyId = thing.GetHistoryId();

Returns

Type	Description
Integer	Primary key.

GetHistoryName()

Declaration

String GetHistoryName()

Examples

NSHistory thing;
String historyName = thing.GetHistoryName();

Returns

Type	Description
String	The name of the history list, for instance contact. Represents the history table's TableId field.

GetId()

Declaration

Integer GetId()

Examples

NSHistory thing;
Integer id = thing.GetId();

Returns

Type	Description
Integer	ID of the history item, for instance a contact id. Represents the history table's RecordId field, if the item is based on a history table record.

GetItemInfo()

Declaration

String GetItemInfo()

Examples

NSHistory thing;
String itemInfo = thing.GetItemInfo();

Returns

Type	Description
String	Extra information on the history item, e.g. The Associate Type for an associate or other relevant info.

GetName()

Declaration

String GetName()

Examples

NSHistory thing;
String name = thing.GetName();

Returns

Type	Description
String	Name of the history item, for instance contact name.

GetRank()

Declaration

Integer GetRank()

Examples

NSHistory thing;
Integer rank = thing.GetRank();

Returns

Type	Description
Integer	Sort order, indexed so it can used for sorting in the query.

SetAssociateId(Integer)

Declaration

Void SetAssociateId(Integer associateId)

Examples

NSHistory thing;
Integer associateId;
thing.SetAssociateId(associateId);

Parameters

Type	Name	Description
Integer	associateId	Owner of history list.

Returns

Type	Description
Void

SetHistoryId(Integer)

Declaration

Void SetHistoryId(Integer historyId)

Examples

NSHistory thing;
Integer historyId;
thing.SetHistoryId(historyId);

Parameters

Type	Name	Description
Integer	historyId	Primary key.

Returns

Type	Description
Void

SetHistoryName(String)

Declaration

Void SetHistoryName(String historyName)

Examples

NSHistory thing;
String historyName;
thing.SetHistoryName(historyName);

Parameters

Type	Name	Description
String	historyName	The name of the history list, for instance contact. Represents the history table's TableId field.

Returns

Type	Description
Void

SetId(Integer)

Declaration

Void SetId(Integer id)

Examples

NSHistory thing;
Integer id;
thing.SetId(id);

Parameters

Type	Name	Description
Integer	id	ID of the history item, for instance a contact id. Represents the history table's RecordId field, if the item is based on a history table record.

Returns

Type	Description
Void

SetItemInfo(String)

Declaration

Void SetItemInfo(String itemInfo)

Examples

NSHistory thing;
String itemInfo;
thing.SetItemInfo(itemInfo);

Parameters

Type	Name	Description
String	itemInfo	Extra information on the history item, e.g. The Associate Type for an associate or other relevant info.

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

NSHistory thing;
String name;
thing.SetName(name);

Parameters

Type	Name	Description
String	name	Name of the history item, for instance contact name.

Returns

Type	Description
Void

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Examples

NSHistory thing;
Integer rank;
thing.SetRank(rank);

Parameters

Type	Name	Description
Integer	rank	Sort order, indexed so it can used for sorting in the query.

Returns

Type	Description
Void