SystemUI.ShowSendGameInvitesAsync Method (IUser, IMultiplayerSessionReference, String, String)

Shows the game invite UI with a specified custom invite string.

Note This method is implemented by the 2015 Multiplayer and applies only to that multiplayer version and later. It is intended for use with template contract 104/105 or later.

Syntax

public:
static IAsyncAction^ ShowSendGameInvitesAsync(
         IUser^ requestingUser,
         IMultiplayerSessionReference^ sessionReferenceToInviteTo,
         String^ inviteDisplayTextId,
         String^ customActivationContext
)

Parameters

requestingUser
Type: IUser

The requesting user.

sessionReferenceToInviteTo
Type: IMultiplayerSessionReference

The session reference for the session hosting the invite.

inviteDisplayTextId
Type: String

The ID of the custom invite string that is displayed with the invite notification. The ID must match the ID that is assigned to the custom invite string in the title’s multiplayer service configuration.

The format of the parameter is “///{id}”, where {id} is replaced with the ID of the custom string.

For example, if the ID of the custom string “Play Capture the Flag” is 1, then you would set this parameter to “///1” in order to display the “Play Capture the Flag” custom string in the game invite.

customActivationContext
Type: String

The custom activation context that is available to the invitee in the activation URI for an invite. The custom activation context string must be URL-safe and binary content should be encoded with URL-safe base64 encoding. The maximum length is 160 characters.

Return value

Type: IAsyncAction

Returns an IAsyncAction object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncAction.Completed property.

Remarks

ShowSendGameInvitesAsync displays the game invite UI and allows the requesting user to select people from the user’s people list and invite them to join the user’s game session. The invite identifies the requesting user.

Requirements

Namespace: Windows.Xbox.UI

Metadata: windows.winmd