TitleCallableUI.ShowGameInviteUIForUserAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ShowGameInviteUIForUserAsync(MultiplayerSessionReference, String, User) |
Shows a picker UI populated from the selected user's friend list and suggested friend list. After selection, the user can send an invitation to play a game and/or party chat for a specified game session to the selected people. |
| ShowGameInviteUIForUserAsync(MultiplayerSessionReference, String, String, User) |
Shows a picker UI populated from the selected user's friend list and suggested friend list. After selection, the user can send an invitation to play a game and/or party chat for a specified game session to the selected people. |
ShowGameInviteUIForUserAsync(MultiplayerSessionReference, String, User)
Shows a picker UI populated from the selected user's friend list and suggested friend list. After selection, the user can send an invitation to play a game and/or party chat for a specified game session to the selected people.
[Windows.Foundation.Metadata.Overload("ShowGameInviteUIForUserAsync1")]
public static Windows.Foundation.IAsyncAction ShowGameInviteUIForUserAsync (Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference sessionReference, string invitationDisplayText, Windows.System.User user);static member ShowGameInviteUIForUserAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference * string * Windows.System.User -> Windows.Foundation.IAsyncActionParameters
- sessionReference
- MultiplayerSessionReference
A reference to the multiplayer session to invite people to.
- invitationDisplayText
- 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. Pass an empty string if you don't want a custom string added to the invite.
- user
- Windows.System.User
System user that identifies which user is sending the invite
Returns
An interface for tracking the progress of the asynchronous call. The operation completes when the UI is closed.
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Applies to
ShowGameInviteUIForUserAsync(MultiplayerSessionReference, String, String, User)
Shows a picker UI populated from the selected user's friend list and suggested friend list. After selection, the user can send an invitation to play a game and/or party chat for a specified game session to the selected people.
[Windows.Foundation.Metadata.Overload("ShowGameInviteUIForUserAsync2")]
public static Windows.Foundation.IAsyncAction ShowGameInviteUIForUserAsync (Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference sessionReference, string invitationDisplayText, string contextStringId, Windows.System.User user);static member ShowGameInviteUIForUserAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference * string * string * Windows.System.User -> Windows.Foundation.IAsyncActionParameters
- sessionReference
- MultiplayerSessionReference
A reference to the multiplayer session to invite people to.
- invitationDisplayText
- 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. Pass an empty string if you don't want a custom string added to the invite.
- contextStringId
- 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.
- user
- Windows.System.User
System user that identifies which user is sending the invite
Returns
An interface for tracking the progress of the asynchronous call. The operation completes when the UI is closed.
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute