This topic has not yet been rated - Rate this topic

GameInviteTask Class

Windows Phone

March 22, 2012

Allows an application to show a game invite screen that allows the user to invite players to a multiplayer game session.

System.Object
  Microsoft.Phone.Tasks.ChooserBase<TaskEventArgs>
    Microsoft.Phone.Tasks.GameInviteTask

Namespace:  Microsoft.Phone.Tasks
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.
public sealed class GameInviteTask : ChooserBase<TaskEventArgs>
<GameInviteTask .../>

The GameInviteTask type exposes the following members.

  Name Description
Public method GameInviteTask Initializes a new instance of the GameInviteTask class.
Top
  Name Description
Public property SessionId Gets or sets a string identifying the network session.
Public property TaskEventArgs The EventArgs for the Completed event. (Inherited from ChooserBase<TTaskEventArgs>.)
Top
  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method FireCompleted Raises the Completed event. (Inherited from ChooserBase<TTaskEventArgs>.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Show Shows the game invite. (Overrides ChooserBase<TTaskEventArgs>.Show().)
Public method ToString (Inherited from Object.)
Top
  Name Description
Public event Completed Occurs when a Chooser task is completed. (Inherited from ChooserBase<TTaskEventArgs>.)
Top

Launch the game invite by calling Show(). Obtain the result of the chooser operation, indicating if the game invite was successfully sent, by handling the Completed event.

Important note Important Note:

Your application may be deactivated while the game invite is in the foreground. To ensure that your application receives the result of the GameInviteTask, the object must be declared with class scope within the PhoneApplicationPage class and you must call the chooser constructor and assign the Completed event delegate within the page’s constructor. For more information about how to handle the activation and deactivation of your application, see Execution Model for Windows Phone.

Windows Phone OS

Supported in: 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Did you find this helpful?
(1500 characters remaining)