Class NSActivitySummaryItem
Summary details about appointments and documents.
Syntax
Constructors
NSActivitySummaryItem()
Initializes a new instance of the NSActivitySummaryItem class.
Declaration
NSActivitySummaryItem
Methods
GetAppointmentId()
Returns the appointment ID (primary key).
Declaration
Integer GetAppointmentId()
Returns
Type | Description |
---|---|
Integer | Appointment Id. |
Examples
NSActivitySummaryItem thing;
Integer appointmentId = thing.GetAppointmentId();
GetCompleted()
The Completed state. NotStarted(1) or Completed(3)
Declaration
Integer GetCompleted()
Returns
Type | Description |
---|---|
Integer |
Examples
NSActivitySummaryItem thing;
Integer completed = thing.GetCompleted();
GetDate()
Start/Document date.
Declaration
DateTime GetDate()
Returns
Type | Description |
---|---|
DateTime |
Examples
NSActivitySummaryItem thing;
DateTime date = thing.GetDate();
GetDescription()
The appointment's textbox; document title.
Declaration
String GetDescription()
Returns
Type | Description |
---|---|
String |
Examples
NSActivitySummaryItem thing;
String description = thing.GetDescription();
GetDocumentId()
Returns the document ID.
Declaration
Integer GetDocumentId()
Returns
Type | Description |
---|---|
Integer | Document ID - 0 if not a document. |
Examples
NSActivitySummaryItem thing;
Integer documentId = thing.GetDocumentId();
GetRegistered()
Returns the registered date.
Declaration
DateTime GetRegistered()
Returns
Type | Description |
---|---|
DateTime |
Examples
NSActivitySummaryItem thing;
DateTime registered = thing.GetRegistered();
SetAppointmentId(Integer)
Primary key
Declaration
Void SetAppointmentId(Integer appointmentId)
Parameters
Type | Name | Description |
---|---|---|
Integer | appointmentId |
Returns
Type | Description |
---|---|
Void |
Examples
NSActivitySummaryItem thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);
SetCompleted(Integer)
Sets the Completed state. NotStarted(1) or Completed(3)
Declaration
Void SetCompleted(Integer completed)
Parameters
Type | Name | Description |
---|---|---|
Integer | completed |
Returns
Type | Description |
---|---|
Void |
Examples
NSActivitySummaryItem thing;
Integer completed;
thing.SetCompleted(completed);
SetDate(DateTime)
Start/Document date
Declaration
Void SetDate(DateTime date)
Examples
NSActivitySummaryItem thing;
DateTime date;
thing.SetDate(date);
SetDescription(String)
Sets the appointment's textbox; document title
Declaration
Void SetDescription(String description)
Parameters
Type | Name | Description |
---|---|---|
String | description |
Returns
Type | Description |
---|---|
Void |
Examples
NSActivitySummaryItem thing;
String description;
thing.SetDescription(description);
SetDocumentId(Integer)
Sets the document ID
Declaration
Void SetDocumentId(Integer documentId)
Parameters
Type | Name | Description |
---|---|---|
Integer | documentId | Document ID; 0 if not a document. |
Returns
Type | Description |
---|---|
Void |
Examples
NSActivitySummaryItem thing;
Integer documentId;
thing.SetDocumentId(documentId);
SetRegistered(DateTime)
Sets the registered date.
Declaration
Void SetRegistered(DateTime registered)
Parameters
Type | Name | Description |
---|---|---|
DateTime | registered |
Returns
Type | Description |
---|---|
Void |
Examples
NSActivitySummaryItem thing;
DateTime registered;
thing.SetRegistered(registered);