GrooveSpaces.CreateInvitationFile2 Operation
Applies to: SharePoint Workspace 2010 | Visual Studio 2008
In this article
HTTP Post URL
Input Message Header
Input Message Parameters
Output Message Header
Return Value
The CreateInvitationFile2 operation returns the contents of an invitation file for a Groove 2007-compatible workspace. You can write the contents to a file, or you can create an invitation e-mail by including the file to an e-mail message. The CreateInvitationFile2 operation provides options not available in the CreateInvitationFile operation. These options include creating a silent invitation, specifying an application to handle the invitation, and requiring a confirmation for the invitation
HTTP Post URL
The HTTP Post URL targets the service for the workspace. This URI is provided by the Read operation in the URI element.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<Role />
<Silent />
<RequireConfirmation />
<ApplicationURI />
<UserData />
Element |
Data type |
Description |
|---|---|---|
Role |
xs:string |
Specifies the workspace role for the invitation as: "$Telespace.Manager", "$Telespace.Member", or "$Telespace.Guest". |
Silent |
xs:boolean |
If true, no notification is displayed to the user when the invitation is received. |
RequireConfirmation |
xs:Boolean |
If true, the member sending the invitation must confirm the acceptance before the invited user becomes a member of the workspace. |
ApplicationURI |
xs:string |
A URI that identifies the application that processes the workspace and invitation. To ensure that ApplicationURI values are unique, we recommend that the URI identifies the organization that is responsible for defining the structure of the workspace and invitation. The recommended URI has the general format of "urn:your-company-namespace:unique-name". |
UserData |
xs:string |
A string that enables the application instance initiating the invitation to communicate with the application instance receiving the information. For example, the application can include XML definitions identifying the names of the inviter and invitee in the UserData. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<CreateInvitationFile2Result />
Element |
Data type |
Description |
|---|---|---|
CreateInvitationFile2Result |
xs:string |
Text of the invitation file. |
Remarks
You can write the returned string to a file that has a .grv file extension. This invitation file can be sent via e-mail or other mechanism to invite new members to the workspace.
To send an invitation using a Groove instant message programmatically, you can use the GrooveMembers.Create2 operation. To display the Groove user interface so that the user can select the contact and send the message, you should use the GrooveLocal.SendInvitation operation.
Note
This operation is available only on systems where Groove Web Services Version 2.1 is available. See Testing for Groove Web Services Version 2.1 for more information.
See Also
Reference
GrooveLocal.SendInvitationAlert Operation
GrooveLocal.SendInvitation Operation
GrooveMembers.Create Operation
GrooveSpaces.CreateInvitationFile Operation