ウェブプッシュ用の BoltzMessenger SDK を使用する

BoltzMessenger のサーバー部分のみを利用して、ウェブサイトにプッシュ通知機能を実装する方法です。

BoltzMessenger SDK の抽出

以下のファイルをboltz-messenger-web.zipより抽出し、適切なディレクトリに配置してください。

web/webroot/js/boltzwebtokens.js (BoltzEngine WebPush Token Library)
web/webroot/js/boltzmessenger.js (BoltzMessenger JavaScript SDK)
web/webroot/serviceworker.js (Service Worker)

このとき、serviceworker.js は表示される画面の URL よりも上のディレクトリに配置する必要があります。詳しくはウェブプッシュの実装方法をご参照ください。

BoltzMessenger SDK の実装

ウェブサイト上に下記のスクリプトを記述してください。function が書かれているところはコールバックですので、状況に対応する処理を記述してください。

 1bm = new BoltzMessenger({
 2    baseUrl: '', // BoltzMessenger Web API URL
 3    serverKey: '', // サーバー公開鍵
 4    serviceWorkerUrl: '', // Service Worker を設置したURL
 5    onInitialState: function(){ 
 6        /* 初期状態(プッシュ通知許可ダイアログ未表示)の処理 */ 
 7    },
 8    onDenied: function(){
 9        /* プッシュ通知拒否状態の処理 */ 
10    },
11    onUnavailable: function(){
12        /* プッシュ通知未対応ブラウザの処理 */ 
13    },
14    onMessageOpen: function(){
15        /* メッセージ開封時の処理 */ 
16    },
17    onReady: function(){
18        /* プッシュ通知許可・登録完了済み時の処理 */ 
19    },
20    onSetupFailed: function(){
21        /* プッシュ通知許可されたが、APIの登録に失敗した場合の処理 */ 
22    },
23});
24bm.start();

得られるインスタンスから BoltzMessenger の API 機能を使用することができます。

提供メソッド一覧

BoltzMessenger クラスは以下のインスタンスメソッドを提供します。詳しい使い方は BoltzMessenger Web の app.js をご覧ください。

start()

BoltzMessenger SDK を起動し、コールバックの呼び出しを開始します。ページ表示後1回だけ呼び出してください。

activate()

プッシュ通知の許可ダイアログの表示をブラウザに要求します。ユーザーが通知を許可すると自動的にプッシュトークンを登録します。

getMessages(onResponse, onError)

メッセージの一覧を取得します。引数はコールバック関数です。

getMessage(messageId, onResponse, onError)

メッセージを1件取得します。引数はコールバック関数です。

getChannels(onResponse, onError)

チャンネルの一覧を取得します。引数はコールバック関数です。

subscribeChannel(channelId, onResponse, onError)

チャンネルに受信登録します。引数はチャンネルID、コールバック関数です。

unsubscribeChannel(channelId, onResponse, onError)

チャンネルから受信登録を解除します。引数はチャンネルID、コールバック関数です。

putSegmentValues(values, onResponse, onError)

セグメント値を登録します。引数はセグメント値のハッシュ、コールバック関数です。

getUserKey()

ユーザーキー(BoltzMessenger 上の登録 ID)を取得します。

getStoredToken()

登録されているBoltzEngine形式ウェブプッシュトークンを取得します。

目次