GrooveSpaces.CreateInvitationFile Operation
The CreateInvitationFile operation returns the contents of an invitation file for the workspace. You can write the contents to a file or can create an invitation e-mail by including the file to an e-mail message.
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 />
Element | Data type | Description |
---|---|---|
Role |
|
Specifies the workspace role for the invitation as: "$Telespace.Manager", "$Telespace.Member", or "$Telespace.Guest". |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<CreateInvitationFileResult />
Element | Data type | Description |
---|---|---|
CreateInvitationFileResult |
|
Text of the invitation file. |
Remarks
You can write the returned string to a file with a .grv filename 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.Create operation. If you want the user to use the Groove user interface to select the contact and send the message, you should use the GrooveLocal.SendInvitation operation.
See Also
Reference
GrooveLocal.SendInvitationAlert Operation
GrooveLocal.SendInvitation Operation
GrooveMembers Web Service
GrooveMembers.Create Operation
GrooveSpaces Web Service