Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Reference material for XGameActivation APIs.
Note
The XGameActivation APIs replace the deprecated XGameProtocol and XGameInvite APIs. New games should use XGameActivation for protocol activation, file activation, and game invite handling. For migration guidance, see Remarks.
Functions
| Function | Description |
|---|---|
| XGameActivationCallback | A callback an application defines for activation events. |
| XGameActivationRegisterForEvent | Registers a callback for activation events. |
| XGameActivationUnregisterForEvent | Unregisters a callback for activation events. |
| XGameActivationAcceptPendingInvite | Accepts a pending game invite. |
Structures
| Structure | Description |
|---|---|
| XGameActivationInfo | Contains the activation information passed to the activation callback. |
Enumerations
| Enumeration | Description |
|---|---|
| XGameActivationType | Specifies the type of activation that occurred. |
Remarks
The XGameActivation APIs provide a unified callback mechanism for all forms of game activation, including protocol activation, file activation, and game invite handling. This replaces the need to separately register with XGameProtocolRegisterForActivation and XGameInviteRegisterForEvent.
Migrating from XGameProtocol and XGameInvite
| Deprecated API | Replacement |
|---|---|
XGameProtocolRegisterForActivation |
XGameActivationRegisterForEvent |
XGameProtocolUnregisterForActivation |
XGameActivationUnregisterForEvent |
XGameInviteRegisterForEvent |
XGameActivationRegisterForEvent |
XGameInviteUnregisterForEvent |
XGameActivationUnregisterForEvent |
XGameInviteRegisterForPendingEvent |
XGameActivationRegisterForEvent |
XGameInviteUnregisterForPendingEvent |
XGameActivationUnregisterForEvent |
XGameInviteAcceptPendingInvite |
XGameActivationAcceptPendingInvite |
Conceptual documentation
See also
System API reference
Protocol activation
File type activation