自定义邀请接口(Custom Invites Interface) 需要1.14.1或更高版本的SDK。
自定义邀请(Custom Invites)接口旨在允许产品通过内置的 Epic Online Service (EOS) Connect 消息系统来发送和接收邀请(包含任意有效载荷)。假如产品已具备一个健壮的邀请系统,并希望用户能通过 Epic账户服务(EAS)覆层UI 来实现邀请的收发,则应将自定义邀请视为唯一适合的邀请接口。
考虑到 Epic游戏商城(Epic Games Store)、 Epic启动程序(Epic Games Launcher) 以及 社交覆层(Social Overlay) 的众多因素,自定义邀请(Custom Invites) 在传输和发送上类似于 会话(Session) 和 大厅(Lobby) 邀请。当商城或启动程序接收到自定义邀请,就会在UI中显示发信人和游戏信息以便提示用户。如果玩家接受该邀请,就会启动相应的产品或游戏。
发送自定义邀请
准备自定义邀请载荷
自定义邀请的载荷(Payload)是FString类型,其长度不得超过 EOS_CUSTOMINVITES_MAX_PAYLOAD_LENGTH
规定的字符长度(当前为500)。其内容对SDK不透明,并且按照原样发送至接收用户。
设置自定义邀请载荷
在尝试发送自定义邀请或允许本地玩家使用社交覆层来发送自定义邀请前,使用 EOS_CustomInvites_SetCustomInvite
设置自定义邀请载荷。所有对 EOS_CustomInvites_SendCustomInvite
的调用以及玩家在覆层中通过 “邀请(INVITE)” 按钮发起的邀请都将使用该载荷。
通过EOS SDK发送自定义邀请
设置好载荷后,你可以使用 EOS_CustomInvites_SendCustomInvite
向特定用户或用户群组发送邀请。
通过社交覆层发送自定义邀请
通过 EOS_CustomInvites_SetCustomInvite
设置自定义邀请载荷后,社交覆层会允许本地玩家使用 “邀请(INVITE)” 按钮向好友发送邀请以及当前设置的自定义邀请载荷。
有关社交面板的更多详情,请参阅社交覆层和SDK接入文档。
处理自定义邀请
注意: EOS覆层由Epic Games启动程序安装。游戏应用也可以用EOS服务Redistributable安装程序,将其作为先决条件的一部分进行安装。有关社交覆层中自定义邀请的更多详情,请参阅社交覆层和SDK接入文档。
回调-自定义邀请接收
你可以使用 EOS_CustomInvites_AddNotifyCustomInviteReceived
和 EOS_CustomInvites_RemoveNotifyCustomInviteReceived
函数执行检测、自定义UI提示,并处理自定义邀请。你必须在登录之前调用,因为登录和初始化能够发现还未发出的自定义邀请,这些邀请会生成即时通知。
处理自定义邀请后(用户接受或拒绝),你必须调用
EOS_CustomInvites_FinalizeInvite
从内部SDK和社交覆层通知中移除。
策略配置
你需要配置客户端策略许可 方可使用自定义策略,以便通过 userRequired 启用用户通知服务并允许:
sendCustomInviteToAnyUser
: 允许用户向任意用户发送自定义邀请。