发送本地推送

HIVE 提供了一個功能，可以通過從遊戲客戶端向設備註冊推送通知來用作遊戲鬧鐘，而無需推送伺服器。這被稱為本地推送。Hive SDK 提供本地推送註冊和釋放功能。註冊的本地推送即使在您關閉應用程序時也會在指定時間通知您，並且可以根據需要取消註冊已註冊的本地推送。

本地推送数据¶

HIVE 在LocalPush類別中定義了本地推送數據，內容如下。

註冊本地推送¶

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

以下是註冊本地推播的範例代碼。

using hive;    
    LocalPush localPush = new 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    
         }    
});

#include "HivePush.h"

FHiveLocalPush LocalPush;
LocalPush.NoticeId = 1;
LocalPush.Title = TEXT("本地推送标题");
LocalPush.Msg = TEXT("本地推送消息");
LocalPush.After = 5;
LocalPush.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 字段表示推送消息的对话形式。此形式定义了如何在屏幕上显示推送消息。 推送消息的对话形式有三个选项。

• 條形類型: 條形顯示在螢幕的頂部，包含 icon、title 和 message。當設備螢幕關閉時，不會顯示通知。
• 彈出類型: 彈出顯示為吐司格式
• 條形和彈出類型: 條形和彈出同時顯示在螢幕上

如果設備螢幕關閉且類型設置為 兩者：條形和彈出類型，則彈出窗口僅顯示為上方的圖像。

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 App To User Notifications 頁面的詳細資訊。

請注意，Facebook 通知功能不斷被 Facebook 更新，導致其行為不斷變化。在 Facebook 通知功能變得穩定之前，Hive SDK 將持續更新。 （v4.16.1 已於 2022 年 10 月跟進並驗證 Facebook 應用程式至 用戶 通知的更新。）

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

當通知到達時，通知的內容會在 Facebook 網頁和應用程式上顯示，如下所示。

在通知菜單中被找到，從遊戲頁面的左側列表切換

在Facebook應用程式上曝光