Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: task ::
service InteractionHandler
Description An interaction request handler that lets the user handle a number of well known requests via GUI dialogs (and the PasswordContainer service). The well known requests handled by this service include ::com::sun::star::ucb::AuthenticationRequest ::com::sun::star::sync2::BadPartnershipException * ::com::sun::star::ucb::HandleCookiesRequest ::com::sun::star::ucb::InteractiveAugmentedIOException * ::com::sun::star::ucb::InteractiveCHAOSException * ::com::sun::star::ucb::InteractiveFileIOException * ::com::sun::star::ucb::InteractiveIOException * ::com::sun::star::ucb::InteractiveNetworkConnectException * ::com::sun::star::ucb::InteractiveNetworkException * ::com::sun::star::ucb::InteractiveNetworkGeneralException * ::com::sun::star::ucb::InteractiveNetworkOffLineException * ::com::sun::star::ucb::InteractiveNetworkReadException * ::com::sun::star::ucb::InteractiveNetworkResolveNameException * ::com::sun::star::ucb::InteractiveNetworkWriteException * ::com::sun::star::ucb::InteractiveWrongMediumException * PasswordRequest ::com::sun::star::java::WrongJavaVersionException * The requests marked with an asterisk are only handled if (a) their continuations match certain restrictions (see below), and (b) the necessary resource strings are available (this can be exploited by applications that carry only a subset of all resource files with them). The continuation restrictions are as follows: Let C be the subset of the provided continuations that are of type XInteractionApprove , XInteractionDisapprove , XInteractionRetry , or XInteractionAbort (or of a derived type). All other continuations are ignored for these requests. The request is only handled if the set C is any of the following: Abort Retry, Abort Approve Approve, Abort Approve, Disapprove Approve, Disapprove, Abort An ::com::sun::star::ucb::InteractiveAugmentedIOException carries with it a sequence of arguments, which should be ::com::sun::star::beans::PropertyValue s. The following details which properties are interpreted by the interaction handler, depending on the request's ::com::sun::star::ucb::IOErrorCode : `"Uri"` All error codes except IOErrorCode::DIFFERENT_DEVICES . The URI of the involved resource (a`string` ). `"ResourceName"` All error codes except IOErrorCode::DIFFERENT_DEVICES . A name for the involved resource (a`string` ) that might be more meaningful to the user than the URI. For example, a (platform-dependent) path notation for file system resources. `"ResourceType"` IOErrorCode::DEVICE_NOT_READY and IOErrorCode::NOT_EXISTING only. An identifier for the type of resource involved (a `string` ). Currently understood values are `"volume"` (e.g., a file system volume) and `"folder"` (i.e., a resource that contains other resources). `"Removable"` IOErrorCode::NOT_EXISTING only. A flag indicating whether the resource resides on a storage medium that can be removed by the user (a`boolean` ). `"Folder"` IOErrorCode::CANT_CREATE only. The name of the foler in which a resource cannot be created (a `string` ). `"Volume"` and`"OtherVolume"` IOErrorCode::DIFFERENT_DEVICES only. The names of the two volumes involved (two `string` s).

Exported Interfaces
XInteractionHandler | Description Handle an interaction request.
::com::sun::star::lang::XInitialization | Description Initialize the interaction handler. The arguments must be a sequence of ::com::sun::star::beans::PropertyValue s. The currently supported properties are: `"Parent"` of type ::com::sun::star::awt::XWindow denotes the parent window for any GUI dialogs the interaction handler pops up; it is strongly recommended that this property is supplied; `"Context"` of type`string` is a textual description of the current context (used, e.g., as a first line of text in error boxes); this property is optional.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.