4.4 Predefined GroupWise Client Identifiers

4.4.1 Identifiers and the GroupWise SDK

The constants listed in this section are simply labels that describe the PersistentID values associated with predefined GroupWise commands. Listed below are the symbolic labels for the predefined commands (effectively #define equivalents) along with their descriptions.

4.4.2 C3PO Data Type Related Identifiers

For C3PO data types (new record types), there is a set of commands (such as Open, Accept, Forward, Delete) that are implicit to the record definitions. When registering a C3PO as supporting a C3PO data type, it is implicitly defined that the C3PO will support (or be asked at runtime if it wants to support) these commands. The commands are:

Event

Description

eGW_CMD_ACCEPT

Accept an instance of the item type.

eGW_CMD_ARCHIVE

Archive an instance of the item type.

eGW_CMD_COMPLETE

Mark an instance of the item type as complete.

eGW_CMD_COMPOSE

Create a new item type.

eGW_CMD_DECLINE

Decline an instance of the item type.

eGW_CMD_DELEGATE

Delegate an instance of the item type.

eGW_CMD_DELETE

Delete an instance of the item type.

eGW_CMD_DIAL

Dial a phone number. Valid for GroupWise 2012.

eGW_CMD_DOC_CHECKIN

Display the check-in time of a document.

eGW_CMD_DOC_CHECKOUT

Display the check-out time of a document.

eGW_CMD_DOC_RESETINUSE

Display when attempting to reset a document’s in-use flag.

eGW_CMD_FORWARD

Forward an instance of the item type.

eGW_CMD_OPEN

Open an instance of the item type.

eGW_CMD_OPENFILEATTACH

Open an instance of the item type (attachment).

eGW_CMD_PRINT

Print an instance of the item type.

eGW_CMD_PROPERTIES

Display the properties for a GroupWise object.

eGW_CMD_REPLY

Reply to an instance of the item type.

eGW_CMD_RESEND

Resend an instance of the item type that is currently in the GroupWise Out Box.

eGW_CMD_SAVE

Save an instance of the item type back to the database.

eGW_CMD_SAVEAS

Save an instance to an external file.

eGW_CMD_SAVEATTACHAS

Save an instance of the item type back to the data base (attachment).

eGW_CMD_SEND

Send an instance of the item type.

eGW_CMD_SETALARMS

Set alarms on a GroupWise object.

eGW_CMD_UNDELETE

Remove an instance of the item type from the GroupWise trash.

eGW_CMD_VIEW

View an instance of the item type.

eGW_CMD_VIEWATTACH

View an instance of the item type (attachment).

4.4.3 Events

The GroupWise client issues several events through the EventMonitor:

Event

Description

eGW_EVT_DELIVERY

Indicates that an item has been delivered to the GroupWise mailbox. A C3PO will typically invoke the GWClientState::SetupDeliveryFolder method and query the corresponding folder when this event is broadcast.

eGW_EVT_OVERFLOW

This notification indicates that too much information has been returned at the same time. When this occurs, you should query the corresponding folder to determine if the information you requested is there.

eGW_EVT_READY

This notification occurs immediately after GroupWise is initialized. The following services are running at the time this method is called: DDE server; OLE objects registered and placed in the COM running object table.

eGW_EVT_SHUTDOWN

A notification to the C3POServer that shutdown is occurring. System services are still available when this notification is received. Immediately after returning from this method call, the C3PO should assume that the calling client has shut down. If the calling client is the last client to use the C3POManager, calls to the Manager will fail after this call has returned.