开发指南

检查游戏公告

游戏侧可通过该 API 获取当前场景下是否存在新的游戏公告，以此设置游戏公告 UI 入口的红点提醒，提示用户查看公告。

支持平台

方法签名

public static void CheckAnnouncements(CheckAnnouncementsOptions opts, Action<Result<CheckAnnouncementsResult>> callback);

代码示例

Show Code

var opts = new CheckAnnouncementsOptions
{
    Profile = "User ID",
    Level = 1
};

ComboSDK.CheckAnnouncements(opts, r =>
{
    if (r.IsSuccess)
    {
        var result = r.Data;
        if (result.newAnnouncementsAvailable) 
        {
            //TODO: 存在新公告处理
        }
    }
    else
    {
        var error = r.Error;
        Debug.LogError("检查游戏公告失败：" + error.DetailMessage)
    }
});

方法参数

Parameters	Required	Type	Description
opts	True	CheckAnnouncementsOptions	检查是否存在新公告所需传入的参数集
callback	True	Action<Result<CheckAnnouncementsResult>>	检查是否存在新公告完成后的回调方法

CheckAnnouncementsOptions

Parameters	Required	Type	Description
Profile	False	string	当前登录的游戏数据的唯一标识，通常为游戏角色 ID
Level	False	int	世游与游戏规定的用于限制公告可见性的指标，通常为游戏角色/账号等级，不传则当成 0 来处理

提示

游戏侧可以根据产品本身的特点选择 Profile 的取值。通常选择游戏角色 ID 即可，但如果游戏本身分区服，且游戏角色 ID 不是全局唯一，则可以用游戏服务器 ID + 游戏角色 ID 得到 Profile。

CheckAnnouncementsResult

Properties	Supported Platforms	Type	Description
newAnnouncementsAvailable		bool	是否有新公告 - true: 有新公告 - false: 没有新公告

打开游戏公告

支持平台

方法签名

public static void OpenAnnouncements(OpenAnnouncementsOptions opts, Action<Result<OpenAnnouncementsResult>> callback);

代码示例

Show Code

var opts = new OpenAnnouncementsOptions
{
    Profile = "User ID",
    Level = 1,
    Width = 70,
    Height = 90
};

ComboSDK.OpenAnnouncements(opts, r =>
{
    if (r.IsSuccess)
    {
        var result = r.Data;
        //TODO: 用户关闭游戏公告页面后的处理（如隐藏提示小红点 UI）
    }
    else
    {
        var error = r.Error;
        Debug.LogError("打开游戏公告失败：" + error.DetailMessage)
    }
});

方法参数

Parameters	Required	Type	Description
opts	True	OpenAnnouncementsOptions	打开游戏公告所需传入的参数集
callback	True	Action<Result<OpenAnnouncementsResult>>	打开游戏公告完成后的回调方法，当游戏公告成功打开时，会在用户关闭游戏公告页面时返回

OpenAnnouncementsOptions

Parameters	Required	Type	Description
Profile	False	string	当前登录的游戏数据的唯一标识，通常为游戏角色 ID
Level	False	int	世游与游戏规定的用于限制公告可见性的指标，通常为游戏角色/账号等级，不传则当成 0 来处理
Width	False	int	公告页面宽度占屏幕宽度的百分比，取值范围为 (0,100]
Height	False	int	公告页面高度占屏幕高度的百分比，取值范围为 (0,100]

提示

• 游戏侧可以根据产品本身的特点选择 Profile 的取值。通常选择游戏角色 ID 即可，但如果游戏本身分区服，且游戏角色 ID 不是全局唯一，则可以用游戏服务器 ID + 游戏角色 ID 得到 Profile。
• Width 和 Height 若不在取值范围内，则使用 SDK 内部的默认显示策略。

OpenAnnouncementsResult

Properties	Supported Platforms	Type	Description

提示

当游戏公告成功打开时，会在用户关闭游戏公告页面时返回，可在此时进行游戏公告页面关闭后的处理，如隐藏新公告提示小红点 UI 等。