POOM object  POOMContact object

Chapter 2: System Object Properties, Events, and Functions

POOMAppointment object

You can add or remove appointments only after you log in using the general POOM object. The POOMAppointment object lets you add or remove recipients, and get or set appointment recurrences, but you must use functions on the general POOM object to add or remove appointments.

Properties

POOMAppointment property

Datatype

Description

AppointmentDuration

Integer

Specifies duration of an appointment in minutes. This is a readonly property that is calculated if you set the AppointmentStart and AppointmentEnd properties.

AppointmentEnd

DateTime

Specifies the end of an appointment. The AppointmentEnd property must always be greater than the AppointmentStart property.

AppointmentStart

DateTime

Specifies the start of an appointment.

Body

String

Specifies annotations for an appointment in text format. The text limit is 60 K. For more information, see the BodyInk property.

BodyInk

Blob

Specifies annotations for an appointment in a blob in Pocket Word Ink (PWI) format that can be set to an Ink control such as the PocketBuilder Signature control.

You must call the Add function on the POOM object to add the appointment to the repository before you set or get the Body and BodyInk properties. When you set one of these properties, its value is automatically updated in the repository.

BusyStatus

POOMBusyStatus (enumeration)

Specifies the availability of the user. Values are:

  • BusyFree! (default)

  • BusyOutOfOffice!

  • BusyTentative!

Categories

String

Specifies the categories to which an appointment is assigned. The text limit for the assigned categories is 1023 characters.

IsAllDayEvent

Boolean

Specifies whether the appointment is for the whole day. The default is false.

IsMeeting

Boolean

Indicates whether there is a meeting request. This is a readonly property. If there are recipients for the appointment, the appointment is considered to be a meeting.

IsRecurring

Boolean

Indicates whether an appointment recurs. This is a readonly property that is set if you specify a recurrence pattern.

IsReminderSet

Boolean

Specifies whether a reminder for an appointment is set.

IsSensitive

Boolean

Specifies whether the appointment is normal or private.

Location

String

Specifies the location of an appointment. The text limit for the location is 1023 characters.

OID

Long

Specifies the object ID for an appointment. This is a direct, read-only property.

ReminderMinutesBeforeStart

Integer

Specifies the time in minutes before an appointment reminder is displayed.

ReminderOptions

Long

Specifies how the reminders for a task are transmitted. Values are:

  • 1 – activates the light-emitting diode (LED)

  • 2 – activates the vibration indicator if one exists

  • 4 – displays a dialog box

  • 8 – plays the sound specified in the ReminderSoundFile property

  • 16 – repeats the reminder

Values are additive. For example, a value of 24 specifies that the designated sound file is played and the reminder is repeated.

ReminderSoundFile

String

Specifies the path to a sound file. Can be used only if IsReminderSet is set to true and the ReminderOptions property is set.

Subject

String

Specifies a subject (topic) for an appointment. The text limit for the subject is 4095 characters.

Functions

POOMAppointment function

Datatype returned

Description

AddRecipient

Integer

Adds the specified recipient for an appointment.

Cancel

Integer

Cancels the appointment, but does not remove it from the repository. Call the Remove function on the POOM object to remove the appointment from the repository.

ClearRecurrencePattern

Integer

Clears the recurrence pattern for an appointment and sets it as an appointment with a single instance.

Display

Integer

Displays the appointment using the default display in Pocket Outlook or the window specified as an optional argument to the POOM Login function.

GetRecipients

Integer

Gets an array of recipients from the POOMRecipient object.

GetRecurrence

POOMRecurrence

Returns the POOMRecurrence object associated with the appointment.

RemoveRecipient

Integer

Removes the specified recipient for the appointment.

Send

Integer

Sends the appointment (meeting request) to all recipients.

SetRecurrence

Integer

Sets a recurrence pattern for an appointment.

Update

Integer

Updates the existing appointment in the repository.





Copyright © 2004. Sybase Inc. All rights reserved. POOMContact object

View this book as PDF