Class NSHistory

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

Syntax

Constructors

NSHistory()

Initializes a new instance of the NSHistory class.

Declaration

NSHistory

Methods

GetAssociateId()

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

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	Owner of history list.

Examples

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

GetHistoryId()

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

Declaration

Integer GetHistoryId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetHistoryName()

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

Declaration

String GetHistoryName()

Returns

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

Examples

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

GetId()

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

Declaration

Integer 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.

Examples

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

GetItemInfo()

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

Declaration

String GetItemInfo()

Returns

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

Examples

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

GetName()

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

Declaration

String GetName()

Returns

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

Examples

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

GetRank()

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

Declaration

Integer GetRank()

Returns

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

Examples

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

SetAssociateId(Integer)

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

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	Owner of history list.

Returns

Type	Description
Void

Examples

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

SetHistoryId(Integer)

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

Declaration

Void SetHistoryId(Integer historyId)

Parameters

Type	Name	Description
Integer	historyId	Primary key.

Returns

Type	Description
Void

Examples

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

SetHistoryName(String)

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

Declaration

Void SetHistoryName(String 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

Examples

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

SetId(Integer)

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

Declaration

Void SetId(Integer 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

Examples

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

SetItemInfo(String)

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

Declaration

Void SetItemInfo(String 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

Examples

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

SetName(String)

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

Declaration

Void SetName(String name)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetRank(Integer)

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

Declaration

Void SetRank(Integer rank)

Parameters

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

Returns

Type	Description
Void

Examples

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