Invitation Complex Type

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

The Invitation type contains the invitation or invitation response.

Syntax

<Invitation>
    <MessageURI />
    <InviterContactURL />
    <InviteeContactURL />
    <SpaceName /> 
    <SpaceURI />
    <SpaceType />
    <Role />
    <UserData />
    <ApplicationURI />
    <InvitationMessgateType /> 
    <InvitationMessageState />
</Invitation>

Complex Type Elements

Element

Data type

Description

MessageURI

xs:anyURI

A unique identifier for the invitation. The MessageURI element provides the HTTP post target URL to accept or decline an invitation or to confirm or deny an invitation response. It can also be used as the HTTP post target URL to read the message body with the GrooveMessages.ReadMessage operation or delete it with the GrooveMessages.Delete operation.

InviterContactURL

xs:anyURI

The IdentityURL of the user who sent the invitation. The InviterContactURL is the user who sends the invitation and receives the invitation response.

InviteeContactURL

xs:anyURI

The IdentityURL of the user who is being invited to the workspace. The InviteeContactURL is the user who receives the invitation and sends the invitation response.

SpaceName

xs:string

The name of the workspace.

SpaceURI

xs:anyURI

The URI that identifies the workspace. When a user is being invited to a workspace, you cannot use this URI to open the workspace until after the user has accepted the invitation and the workspace has been fetched.

SpaceType

xs:anyURI

A URN that identifies the type of the workspace. If the workspace is a generic Groove workspace, the Type is urn:groove.net:Groove.Core.Tools.System.TelespaceTypes.Generic. If the workspace is a Groove File Sharing workspace, the Type is as follows: urn:groove.net:Groove.Core.Tools.System.TelespaceTypes.GFS.

Role

xs:string

Specifies the member's role within the workspace with one of the following strings: "$Telespace.Manager" for manager, "$Telespace.Member" for participant, and "$Telespace.Guest" for guest.

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.

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".

InvitationMessageType

InvitationMessageType

An enumeration type that identifies whether the message is an invitation or an invitation response. This type has one of the following values:

  • "InvitationReceived"—message is an invitation.

  • "InvitationAccepted"—message is an invitation response and user accepted the invitation.

  • "InvitationDeclined"—message is an invitation response and user declined the invitation.

  • "ConfirmationRequired"—message is an invitation response, user accepted the invitation, and the application must confirm the acceptance.

InvitationMessageState

InvitationMessageState

An enumeration type indicating whether the invitation or invitation response is a "New" or "Saved" message.

See Also

Reference

GrooveMessages Web Service

Concepts

Accessing Groove Messages