发送本地推送

HIVE 提供了一种功能，可以通过从游戏客户端向设备注册推送通知来用作游戏闹钟，而无需推送服务器。这被称为本地推送。Hive SDK 提供本地推送注册和释放功能。注册的本地推送将在您关闭应用程序时仍会在指定时间通知您，并且可以根据需要取消注册已注册的本地推送。

本地推送数据¶

HIVE在LocalPush类中定义了本地推送数据，内容如下。

注册本地推送¶

要在用户设备上注册本地推送通知，请调用Push类的registerLocalPush()方法。

以下是注册本地推送的示例代码。

using hive;    
    LocalPush localPush = new LocalPush ();    
    localPush.noticeId = 1;    
    localPush.title = "本地推送标题";    
    localPush.msg = "本地推送消息";    
    localPush.after = 5;    
    localPush.groupId = "a";    

    Push.registerLocalPush(localPush, (ResultAPI result, LocalPush localPush) => {    
         if (result.isSuccess()) {    
             // call successful    
         }    
});

#include "HivePush.h"

FHiveLocalPush 本地推送;
本地推送.NoticeId = 1;
本地推送.Title = TEXT("本地推送标题");
本地推送.Msg = TEXT("本地推送消息");
本地推送.After = 5;
本地推送.GroupId = TEXT("a");

FHivePush::RegisterLocalPush(LocalPush, FHivePushOnLocalPushDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHiveLocalPush& LocalPush) {
        if (Result.IsSuccess()) {
                // API调用成功
        }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;    
    using namespace hive;    
    LocalPush localPush;    
    localPush.noticeId = 1;    
    localPush.title = "Local Push Title";    
    localPush.msg = "Local Push Message";    
    localPush.after = 5;    
    localPush.groupId = "a";    

    Push::registerLocalPush(localPush, [=](ResultAPI result, LocalPush localPush){    
         if (result.isSuccess()) {    
             // call successful    
         }    
});

import com.hive.Push    
    import com.hive.ResultAPI    
    val localPush = Push.LocalPush().apply {    
         noticeID = 1    
         title = "Local Push Title"    
         msg = "Local Push Message"    
         after = 5    
         groupId = "a"    
    }    
    Push.registerLocalPush(localPush, object : Push.LocalPushListener {    
         override fun onRegisterLocalPush(result: ResultAPI, localPush: Push.LocalPush?) {    
             if (result.isSuccess) {    
                 // call successful    
             }    
         }    
})

import com.hive.Push;    
    import com.hive.ResultAPI;    
    Push.LocalPush localPush = new Push.LocalPush();    
    localPush.setNoticeID(1);    
    localPush.setTitle("Local Push Title");    
    localPush.setMsg("Local Push Message");    
    localPush.setAfter(5);    
    localPush.setGroupId("a");    
    Push.INSTANCE.registerLocalPush(localPush, (result, localPushData) -> {    
         if (result.isSuccess()) {    
             // call successful    
         }    
});

import HIVEService    
    let localPush = LocalPush()    
    localPush.noticeId = 1;    
    localPush.title = "Local Push Title";    
    localPush.msg = "Local Push Message";    
    localPush.after = 5;    
    localPush.groupId = "a";    
    PushInterface.registerLocalPush(localPush) { result, localPush in    
    if result.isSuccess() {    
    // call successful    
    }    
}

#import <HIVEService/HIVEService-Swift.h>    
    HIVELocalPush *localPush = [[HIVELocalPush alloc] init];    
    localPush.noticeId = 1;    
    localPush.title = @"本地推送标题";    
    localPush.msg = @"本地推送消息";    
    localPush.after = 5;    
    localPush.groupId = @"a";    

    [HIVEPush registerLocalPush: localPush handler: ^(HIVEResultAPI *result, HIVELocalPush *localPush) {    
         if ([result isSuccess]) {    
             // call successful    
         }    
}];

取消本地推送¶

您可以在指定的通知时间之前取消注册已注册的本地推送通知。

注销已注册的本地推送 使用以下API，将注册的推送标识符作为参数（noticeId），并注销本地推送。

using hive;    
    int noticeId = 1; // local push unique ID    
Push.unregisterLocalPush(noticeId);

#include "HivePush.h"

int32 通知ID = 1; // 本地推送唯一ID 

FHivePush::UnregisterLocalPush(NoticeID);

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;    
    using namespace hive;    
    int noticeId = 1; // local push unique ID    
Push::unregisterLocalPush(noticeId);

import com.hive.Push    
    val noticeId = 1 // local push unique ID    
Push.unregisterLocalPush(noticeId)

import com.hive.Push;    
    int noticeId = 1; // local push unique ID    
Push.INSTANCE.unregisterLocalPush(noticeId);

import HIVEService    
    let noticeId = 1 // local push unique ID    
PushInterface.unregisterLocalPush(noticeId)

#import <HIVEService/HIVEService-Swift.h>    
    NSInteger noticeId = 0; // local push unique ID    
[HIVEPush unregisterLocalPush: noticeId];

一次性注销列出的本地推送

使用以下 API，您可以创建已注册的本地推送标识符列表，并一次性注销本地推送。

using hive;    
    List noticeIds = new List { 1, 2, 3 }();    
Push.unregisterLocalPushes(noticeIds);

#include "HivePush.h"

TArray<int32> NoticeIds = { 1, 2, 3 };

FHivePush::UnregisterLocalPushes(NoticeIds);

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;    
    using namespace hive;    
    vector noticeIds = { 1, 2, 3 };    
Push::unregisterLocalPushes(noticeIds);

import com.hive.Push    
    val noticeIds = arrayListOf(1, 2, 3)    
Push.unregisterLocalPushes(noticeIds)

import com.hive.Push;    
    ArrayList<Integer> noticeIds = new ArrayList<>();    
    noticeIds.add(1);    
    noticeIds.add(2);    
    noticeIds.add(3);    
Push.INSTANCE.unregisterLocalPushes(noticeIds);

import HIVEService    
    let noticeIds = [1, 2, 3]    
PushInterface.unregisterLocalPushes(noticeids)

#import <HIVEService/HIVEService-Swift.h>    
    NSArray* noticeIds = @[ @(1), @(2), @(3) ];    
[HIVEPush unregisterLocalPushes: noticeIds];

注销所有本地推送

使用以下 API，您不仅可以注销 Hive SDK 的本地推送，还可以注销所有处于监听状态的本地推送。

using hive;    
Push.unregisterAllLocalPushes();

#include "HivePush.h"

FHivePush::UnregisterAllLocalPushes();

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;    
    using namespace hive;    
Push::unregisterAllLocalPushes();

import com.hive.Push    
Push.unregisterAllLocalPushes()

import com.hive.Push;    
Push.INSTANCE.unregisterAllLocalPushes();

import HIVEService    
PushInterface.unregisterAllLocalPushes()

#import <HIVEService/HIVEService-Swift.h>    
[HIVEPush unregisterAllLocalPushes];

自定义本地推送 UI (仅限 Android)¶

本地推送可以在Android设备上进行自定义。有关要自定义的UI元素的信息设置在registerLocalPush()方法的LocalPush类参数中，该方法注册本地推送以及推送设置信息。

本地推送 UI¶

本地推送 UI 的自定义数据在 LocalPush 类中定义，该类定义了本地推送设置的数据。下表描述了与 UI 项目相关的 LocalPush 类中的一些可更改字段。 某些字段名称链接到详细信息。点击字段名称以查看带有屏幕截图的更多详细信息。

type 字段¶

type 字段表示推送消息的对话形式。此形式定义了如何在屏幕上显示推送消息。 推送消息的对话形式有三个选项。

• 条形类型：条形显示在屏幕顶部，包含 图标、标题 和 消息。当设备屏幕关闭时，不会显示通知。
• 弹出类型：弹出以吐司格式显示
• 条形和弹出类型：条形和弹出都显示在屏幕上

如果设备屏幕关闭并且类型设置为**条形和弹出类型**，则弹出窗口仅作为图像显示在上方。

bigmsg 和 bigpicture 字段¶

请查看下面的图像，以检查显示在屏幕上的大消息和大图片。

• 使用 bigmsg 字段来显示一大段文本。ticker 字段可与 bigmsg 一起使用。
• 使用 bigpicture 字段，您可以在通知屏幕上显示大尺寸图片。
• bigpicture 与 bigmsg 不可用。
• bigpicture 可与 ticker 一起使用。

buckettype 字段¶

如果显示多个通知并且buckettype字段的值为1或2，则堆叠的通知会显示在一个部分上。

• bucketsize 指的是在通知栏上显示的消息数量。
• 如果 buckettype 的值为 1，表示收件箱类型，如果消息超过一行，则会添加省略号 (...)，并且超出屏幕的内容不会显示。
• 如果 buckettype 的值为 2，则整个文本会显示在屏幕上。
• buckettype 可以与 ticker 一起使用。

发送 Facebook 云游戏 通知 (Android)¶

通过Hive SDK提供的本地推送功能，您可以使用来自Facebook Cloud Game构建的Facebook应用程序到用户通知。

对于 Facebook 通知，有一些限制，这些限制与 Android 的普通推送不同。请查看 Facebook 应用到 用户 通知 页面上的详细信息。

请注意，Facebook 通知功能正在不断更新，导致其行为不断变化。在 Facebook 通知功能变得稳定之前，Hive SDK 将持续更新。 （v4.16.1 已于 2022 年 10 月跟进并验证了 Facebook 应用程序到 用户 通知的更新。）

Facebook通知功能所需的数据必须在LocalPush类中定义。下表定义了LocalPush类的哪些字段是Facebook通知所必需的。

当通知到达时，通知的内容将在Facebook网页和应用程序上显示，如下所示。

在通知菜单中被找到，从游戏页面的左侧列表切换

在Facebook应用上曝光