通过

XGameUiShowSendGameInviteAsync

  • 项目

此方法显示从所选玩家的好友列表和建议的好友列表填充的选取器 UI，以便发送游戏邀请。

语法

HRESULT XGameUiShowSendGameInviteAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         const char* sessionConfigurationId,  
         const char* sessionTemplateName,  
         const char* sessionId,  
         const char* invitationText,  
         const char* customActivationContext  
)

参数

async _In_
类型：XAsyncBlock*

指向传递到 XAsyncRun 的 XAsyncBlock 的指针。

requestingUser _In_
类型：XUserHandle

正在发送邀请的用户的句柄。

sessionConfigurationId _In_
类型：char*

指定一个字符串，它指示游戏的服务配置 ID。

sessionTemplateName _In_
类型：char*

指定一个字符串，它指示多人游戏会话模板的名称。

sessionId _In_
类型：char*

指定一个字符串，它指示要将人员邀请到的多人游戏会话的 ID。

invitationText _In_opt_
类型：char*

指定一个字符串，它指示自定义邀请字符串 ID。
在 Xbox Live 服务配置中定义此字符串 ID，用于识别标准邀请文本之外的邀请文本。 ID 字符串必须以“///”为前缀。 如果您不希望将自定义字符串添加到邀请，则传递空字符串。

customActivationContext _In_opt_
类型：char*

可在某一邀请的激活 URI 中供邀请人使用的自定义激活上下文。 自定义激活上下文字符串必须是 URL 安全的，并且应使用 URL 安全的 base64 编码对二进制内容进行编码。 最大长度为 160 个字符。

返回值

类型：HRESULT

异步调用的 HRESULT 成功或错误代码。

备注

在填充列表后，可以选择玩家。 玩家可以向选取器 UI 中选择的个人发送玩游戏和/或针对某一指定的会话游戏进行群聊天的邀请。

调用 UI 将导致游戏进入约束模式。 在约束模式下，您的游戏将在处于已调用的 UI 的后台中时接收较少的系统资源。 要详细了解游戏的约束模式和其他操作模式，请参阅 Xbox 游戏生命周期（NDA 主题）。

要求

头文件： XGameUI.h

库：xgameruntime.lib

支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XGameUI
XGameUiShowSendGameInviteResult
Xbox 游戏生命周期（NDA 主题）