This topic has not yet been rated - Rate this topic

GameInviteTask Class

April 12, 2014

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

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.

  NameDescription
Public methodGameInviteTaskInitializes a new instance of the GameInviteTask class.
Top
  NameDescription
Public propertySessionIdGets or sets a string identifying the network session.
Public propertyTaskEventArgsThe EventArgs for the Completed event. (Inherited from ChooserBase<TTaskEventArgs>.)
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodFireCompletedRaises the Completed event. (Inherited from ChooserBase<TTaskEventArgs>.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShowShows the game invite. (Overrides ChooserBase<TTaskEventArgs>.Show().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public eventCompletedOccurs 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 noteImportant 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.

Windows Phone OS

Supported in: 8.1, 8.0, 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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.