Class History

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

Carrier object for History. Services for the History Carrier is available from the ViewState Agent.
Inheritance
object
History
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class History : Carrier
Examples

Get History 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ViewStateAgent();
   var history = agent.GetHistory( 123 );
}

Constructors

History()

Default constructor

Declaration
public History()
See Also

Properties

AssociateId

Owner of history list

Declaration
[DataMember]
public virtual int AssociateId { get; set; }
Property Value
Type Description
int
See Also

HistoryId

Primary key

Declaration
[DataMember]
public virtual int HistoryId { get; set; }
Property Value
Type Description
int
See Also

HistoryName

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

Declaration
[DataMember]
public virtual string HistoryName { get; set; }
Property Value
Type Description
string
See Also

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

Declaration
[DataMember]
public virtual int Id { get; set; }
Property Value
Type Description
int
See Also

ItemInfo

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

Declaration
[DataMember]
public virtual string ItemInfo { get; set; }
Property Value
Type Description
string
See Also

Name

Name of the history item, for instance contact name

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

Rank

Sort order, indexed so it can used for sorting in the query

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also