ローカルプッシュの送信

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 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 call successfull
        }
}));

#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 = "ローカルプッシュタイトル"    
         msg = "ローカルプッシュメッセージ"    
         after = 5    
         groupId = "a"    
    }    
    Push.registerLocalPush(localPush, object : Push.LocalPushListener {    
         override fun onRegisterLocalPush(result: ResultAPI, localPush: Push.LocalPush?) {    
             if (result.isSuccess) {    
                 // 成功を呼び出す    
             }    
         }    
})

import com.hive.Push;    
    import com.hive.ResultAPI;    
    Push.LocalPush localPush = new Push.LocalPush();    
    localPush.setNoticeID(1);    
    localPush.setTitle("ローカルプッシュタイトル");    
    localPush.setMsg("ローカルプッシュメッセージ");    
    localPush.setAfter(5);    
    localPush.setGroupId("a");    
    Push.INSTANCE.registerLocalPush(localPush, (result, localPushData) -> {    
         if (result.isSuccess()) {    
             // 成功した呼び出し    
         }    
});

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 = @"Local Push Title";    
    localPush.msg = @"Local Push Message";    
    localPush.after = 5;    
    localPush.groupId = @"a";    

    [HIVEPush registerLocalPush: localPush handler: ^(HIVEResultAPI *result, HIVELocalPush *localPush) {    
         if ([result isSuccess]) {    
             // 成功した場合の呼び出し    
         }    
}];

ローカルプッシュの登録解除¶

指定された通知時間の前に、登録されたローカルプッシュ通知を登録解除することができます。

登録されたローカルプッシュを登録解除する 次の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フィールドはプッシュメッセージのダイアログ形式を意味します。この形式は、プッシュメッセージを画面に表示する方法を定義します。 プッシュメッセージのダイアログ形式には3つのオプションがあります。

• バータイプ: バーは画面の上部にアイコン、タイトル、およびメッセージと共に表示されます。デバイスの画面がオフのときは通知は表示されません。
• ポップアップタイプ: ポップアップはトースト形式で表示されます
• バーとポップアップの両方のタイプ: バーとポップアップの両方が画面に表示されます

デバイスの画面がオフで、タイプが**バーとポップアップタイプの両方**に設定されている場合、ポップアップは画像のみが上に表示されます。

bigmsg と bigpicture フィールド¶

下の画像を見て、大きなメッセージと画面に表示された大きな画像を確認してください。

• bigmsgフィールドを使用して大量のテキストを表示します。tickerフィールドはbigmsgと一緒に使用できます。
• bigpictureフィールドを使用すると、通知画面に大きなサイズの画像を表示できます。
• bigpictureはbigmsgと一緒には使用できません。
• bigpictureはtickerと一緒に使用できます。

buckettype フィールド¶

複数の通知が表示され、buckettypeフィールドの値が1または2の場合、スタックされた通知がセクションに表示されます。

• bucketsize は通知バーに表示されるメッセージの数を意味します。
• buckettype の値が 1 の場合、つまりインボックスタイプであり、メッセージが1行を超えると、エリプシス (...) が追加され、画面外の内容は表示されません。
• buckettype の値が 2 の場合、全てのテキストが画面に表示されます。
• buckettype は ticker と共に使用できます。

Facebook cloud game通知を送信する (Android)¶

Hive SDKのローカルプッシュ機能を使用して、Facebook Cloud Gameビルドから提供される、Facebookアプリからユーザー通知を利用できます。

Facebookの通知には、Androidの通常のプッシュとは異なる制限があります。詳細については、Facebookアプリからユーザー通知のページをご確認ください。

Facebookの通知機能は常にFacebookによって更新されており、その動作に常に変化をもたらしています。Facebookの通知機能が安定するまで、Hive SDKは継続的に更新されます。 (v4.16.1は2022年10月時点でFacebookアプリからユーザー通知の更新をフォローアップし、確認しました。)

Facebook通知機能に必要なデータは、LocalPushクラスで定義する必要があります。以下の表は、Facebook通知に必要なLocalPushクラスのフィールドを定義しています。

通知が届くと、通知の内容が以下のようにFacebookのウェブページとアプリに表示されます。

ゲームページの左リストから切り替えられる通知メニューに見つかること

Facebookアプリに表示されること