Appointments

From Pointui

This is a Global object. You must not create an instance of it as one is always available for your use.

Provides access to calendar appointments. NOTE: this is a global object so an instance is always available to use – you do not need to ever create additional instances.

Contents

Methods

void GetAppointments(DataTable result)

Returns the entire list of appointments in the calendar including recurring appointments. The DataTable “result” will be set to contain the appointments, which could be zero or more.

The DataTable supports the following columns:

columnName Expected Data Type
Subject String
Location String
Categories String
Body String
BusyStatus int
Duration int
IsRecurring bool
MeetingStatus int
ObjectID int
ReminderSet bool
AllDayEvent bool
Start DateTime
End DateTime

EXAMPLE 

DataTable appts;
Appointments.GetAppointments(appts);
while (appts.MoveNext())
{
	//do something with appointments
}

void Display(int objectID)

Displays the default OS screen for a specific appointment. Each appointment has a unique id which can be retrieved using DataTable.GetValue(“ObjectID”).

PARAMETERS

  • objectID – the unique ID of the appointment object.

EXAMPLE 

//get appointments
DataTable appts;
Appointments.GetAppointments(appts);
//move to first appointment
appts.MoveNext();
//get the unique id for the appointment
int oid;
appts.GetValue(“ObjectID”, oid);
//display the OS screen for this appointment
Appointments.Display(oid);

void DisplayApp(DateTime focusDay)

Displays the default OS calendar application focused on the specified day.

PARAMETERS

  • focusDay – the day to focus when the OS calendar application is displayed.

EXAMPLE 

DateTime tomorrow;
tomorrow.Now();
tomorrow.AddDays(1);
Appointments.DisplayApp(tomorrow);

void Create(Appointment result)

AVAILABLE SINCE: 2.1 Creates a new appointment with no properties set, not even a name or unique ObjectID. Before an ObjectID property value can be retrieved the resulting Contact object must have it’s Save() method called. Also, other methods such as Display() may fail on the resulting Appointment object if called before Save().

void GetCategories(DataTable result)

AVAILABLE SINCE: 2.1 Fills the result DataTable with the list of appointment categories.

Retrieved from "http://docs.pointui.com/Appointments"