GameInviteTask Class

Article
11/23/2015

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

Inheritance Hierarchy

System..::.Object
Microsoft.Phone.Tasks..::.ChooserBase<(Of <(TaskEventArgs>)>)
Microsoft.Phone.Tasks..::.GameInviteTask

Namespace: Microsoft.Phone.Tasks
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Public NotInheritable Class GameInviteTask _
    Inherits ChooserBase(Of TaskEventArgs)

public sealed class GameInviteTask : ChooserBase<TaskEventArgs>

<GameInviteTask .../>

The GameInviteTask type exposes the following members.

Constructors

	Name	Description
	GameInviteTask	Initializes a new instance of the GameInviteTask class.

Top

Properties

	Name	Description
	SessionId	Gets or sets a string identifying the network session.
	TaskEventArgs	The EventArgs for the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FireCompleted	Raises the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Show	Shows the game invite. (Overrides ChooserBase<(Of <(TTaskEventArgs>)>)..::.Show()()().)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Completed	Occurs when a Chooser task is completed. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Remarks

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:
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, seeApp activation and deactivation for Windows Phone 8.

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, seeApp activation and deactivation for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Platforms

Windows Phone

Thread Safety

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