GrooveLocal Web Service
The GrooveLocal service provides a mechanism for a Groove Web Services application to open a specific window of the Groove user interface so that the local user can view information or perform some action. In addition, it provides operations to open files stored in the Groove Files tool and to send an invitation alert to a workspace member.
XML Definitions
WSDL
GrooveLocal.wsdl
2.0
with references to:
Core.xsd
2.0Local.xsd
2.0
SOAP Operation Namespace
http://webservices.groove.net/Groove/2.0/Local/
HTTP Post URL
https://localhost:
port-number/GWS/Groove/2.0/
Local/service-specific-data
Operations, Complex Types, and Events
The following sections describe the GrooveLocal operations.
Operations
Operation | Description |
---|---|
Opens a file stored in a Groove Files tool. The file is opened by its related application. |
|
Opens a window with an informational message about Groove. |
|
Opens a window with the account configuration wizard. |
|
Opens a window that provides the user the ability to add a new personal contact. |
|
Opens a window with the account Communications Manager. |
|
Opens a window with the contact information for the specified contact. |
|
Opens a window with that provides the user the ability to interactively create a new workspace. |
|
Opens a window with the Groove Launchbar that provides the user the ability to view the workspaces available in Groove. |
|
Opens the About Groove window, which provides access to the Microsoft Office license agreement. |
|
Opens a window with the account message history. |
|
Opens a window with the account preferences. |
|
Opens a window with the workspace properties. |
|
Opens a window with the tool properties. |
|
Opens a window provides the user the ability to edit the user's own identity information. |
|
Opens a window to send a message to the specified Groove identity. |
|
Opens a window to invite a user to the specified workspace. |
|
Sends a message that requests a workspace member to go to the workspace. |
|
This operation is obsolete. Calling this operation has no effect. |
|
Enables or suppresses alerts for all accounts on the device. |
|
Opens a window that provides access to the specified workspace, tool, or Forms tool record in the Groove user interface. |
Complex Types
Complex type | Description |
---|---|
Enumerated type that specifies whether alerts should be enabled or suppressed for all accounts on the device. |
Remarks
When a GrooveLocal operation opens a window, it is displayed to the user and controlled by the user. The GrooveLocal operation returns immediately after opening the window and does not wait for the user to dismiss the window. The Groove Web Services application has no mechanism to dismiss the window; the window can only be dismissed by the user.
In order for the Groove process to set a window to the foreground while the Groove Web Services application is running, the application must grant the Groove process permission to do this with the Microsoft Windows® AllowSetForegroundWindow() function.
Typically, a Groove Web Services application opens a Groove user interface window in response to an action by the user. For example, the user may click on a button in the application window.
The GrooveLocal service cannot be used on a Groove Data Bridge system.