Novell Doc: GroupWise SDK: Custom Third-Party Object (C3PO) - ClientState Implementation (Subclass)

Properties

The following table lists the properties for this class, along with access and descriptions:

Property	Access	Description
AttachmentControl	R/O	AttachmentControl. Available beginning with the ClientState3 interface. Valid for GroupWise 6.0 and support packs for GroupWise EP.
ClientName	R/O	String. "GroupWise."
CommandMessage	R/O	Message. The Message object associated with the command object being executed. For example, when a predefined command is issued (such as Forward, Open, or Delegate), this property identifies the message associated with the command. CommandMessage isn't available for new messages. If you try to access Manager.ClientState.CommandMessage from a new message, GroupWise 6.5 throws an “Unspecified error” exception.
CurrentAccount	R/O	Account. The account object currently being accessed. Available beginning with the ClientState2 interface.
HighlightedFolder	R/O	Returns the currently highlighted folder in the folder tree. Usually, the highlighted folder is identical to the selected folder. However, they differ when the user is right-clicking another folder. The folder that is being right-clicked will be highlighted, but the previous folder still remains selected.
HTMLEditor	R/O	Provides editing access to the IHTMLDocument interface provided by the Internet Explorer browser.
HTMLViewer	R/O	Provides viewing access to the ITHMLDocument interface provided by the Internet Explorer browser.
MajorVersion	R/O	Long. 5.
MinorVersion	R/O	Long. 0.
SelectedFolder	R/O	Folder. The currently selected folder. For open message items, this property is NULL. For the browser window, this is the folder selected in the folder tree. Calendar windows have the ability to multi-select the folders that are displayed, in which case, this property is the "caret" folder (or focus selection) in the folder tree.
SelectedMessages	R/O	MessageList. The currently selected set of messages.

Methods

RevokeDeliveryFolder( string MessageClass, [Variant Target] )

Reverses the effect of calling SetupDeliveryFolder. Messages of the given class will no longer be linked to the target folder. If multiple servers are monitoring a given message class, this method will remove the delivery folder for all servers. There is no type of "reference count" associated with calls to SetupDeliveryFolder.

MessageClass names a specific message type.

Target names the target folder. Target can be a Folder object from the Object API or a string. A string value is interpreted to be a full folder path. For example, \\user_full_name\folder A\Folder B would indicate that Folder B is the target folder. Note that for GroupWise 5.x and 6.x, this parameter must always be omitted.

SetupDeliveryFolder( string MessageClass, [Variant Target])

Causes messages of the specified class to be automatically linked to the named folder. This is accomplished by creating a rule that causes items of the designated class to be linked to the folder upon delivery of the item.

MessageClass names a specific message type.

Target names the target folder. Target can be a Folder object from the Object API or a string. A string value is interpreted to be a full folder path. For example, \\user_full_name\folder A\Folder B would indicate that Folder B is the target folder. Note that for GroupWise 5.x and 6.x, this parameter must always be omitted.

A C3PO would invoke this method to facilitate the management of messages. For example, processing of delivered items can be accomplished by using this method. The C3POServer would query the folder when the deliver event is passed to the EventMonitor.

If more than one C3PO invokes this method with the same parameters, the GWClientState object will attempt to resolve to the same rule. This is done through the naming of the rule.

Each C3POServer should take care to invoke this method only once. The server must keep a one-time init flag (perhaps in the registry) to guarantee that it invokes the method only once. The startup overhead with this API is substantial and should be avoided.

Remarks

GWClientState is not intended to replace the functionality of the Object API. The GroupWise 5.x and 6.x implementations of GWClientState is intentionally minimal because adequate functionality is available in the Object API.