XGameUiShowStateShareAsync

Note that this method is a preview in the June 2024 GDK. This method shows a UI populated with metadata related to the state being shared and UX affordances for sharing the state either as a web link or a direct invite.

Syntax

HRESULT XGameUiShowStateShareAsync(
  XAsyncBlock * async,
  XUserHandle requestingUser,
  const char * linkToken
)

Parameters

async _In_ Type: XAsyncBlock * A pointer to the XAsyncBlock that is passed to XAsyncRun. requestingUser _In_
Type: XUserHandle A handle to the user that is sending the invites. linkToken _In_z_
Type: const char * A linkToken that references the state to be shared.

Remarks

To share a state with UI, after creating a state and a corresponding link, the title should call the XGameUiShowStateShareAsync API passing along the requesting user and the link token acquired as part of creating the link for the state. Using PlayFab is one way to create states and links, reach out to your Microsoft Representative for details.

Requirements

Header: XGameUI.h Library: xgameruntime.lib Supported platforms: Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Remarks

Requirements

See also

​Syntax

​Parameters

​Remarks

​Requirements

​See also

Syntax

Parameters

Remarks

Requirements

See also