Show / Hide Table of Contents

Class NSActivitySummary

Activity information summary - number of free and busy activities. Carrier object for ActivitySummary.

Syntax

Constructors

NSActivitySummary()

Initializes a new instance of the NSActivitySummary class.

Declaration
NSActivitySummary

Methods

GetNumBusyActivities()

Returns the number of activities and tasks in the diary that are of type 'busy'.

Declaration
Integer GetNumBusyActivities()
Returns
Type Description
Integer

The number of activities and tasks in the diary of type busy.

Remarks

Sales and documents are not activities in this case, only diary appointments and tasks.

Examples
NSActivitySummary thing;
Integer numBusyActivities = thing.GetNumBusyActivities();

GetNumFreeActivities()

Returns the number of activities of the type 'free'.

Declaration
Integer GetNumFreeActivities()
Returns
Type Description
Integer

The number of activities of type free.

Remarks

Sales and documents are not activities in this case, only diary appointments and tasks.

Examples
NSActivitySummary thing;
Integer numFreeActivities = thing.GetNumFreeActivities();

GetPercentageBusy()

Checks how much of the active work-day that is booked in appointments.

Declaration
Integer GetPercentageBusy()
Returns
Type Description
Integer

How much of the active work-day that is booked in appointments.

Examples
NSActivitySummary thing;
Integer percentageBusy = thing.GetPercentageBusy();

SetNumBusyActivities(Integer)

Sets the number of activities and tasks in the diary that are of type 'busy'.

Declaration
Void SetNumBusyActivities(Integer numBusyActivities)
Parameters
Type Name Description
Integer numBusyActivities

The number of activities and tasks in the diary that are of type busy.

Returns
Type Description
Void
Remarks

Sales and documents are not activities in this case, only diary appointments and tasks.

Examples
NSActivitySummary thing;
Integer numBusyActivities;
thing.SetNumBusyActivities(numBusyActivities);

SetNumFreeActivities(Integer)

Sets the number of activities of the type 'free'.

Declaration
Void SetNumFreeActivities(Integer numFreeActivities)
Parameters
Type Name Description
Integer numFreeActivities

The number of activities of the type free.

Returns
Type Description
Void
Remarks

Sales and documents are not activities in this case, only diary appointments and tasks.

Examples
NSActivitySummary thing;
Integer numFreeActivities;
thing.SetNumFreeActivities(numFreeActivities);

SetPercentageBusy(Integer)

Sets how much of the active work-day that is booked in appointments.

Declaration
Void SetPercentageBusy(Integer percentageBusy)
Parameters
Type Name Description
Integer percentageBusy

How much of the active work-day that is booked in appointments.

Returns
Type Description
Void
Examples
NSActivitySummary thing;
Integer percentageBusy;
thing.SetPercentageBusy(percentageBusy);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top