- PhoneGap/Cordova 9.0 ~ Cordova 12.0
- iOSの対応環境：
- iOS 13.x ~ iOS 17.x
- Androidの対応環境：
| Android | Android APIレベル | NIFCLOUDMB (ncmb-push-monaca-plugin) |
Cordova | ビルド環境設定 | その他 |
|---|---|---|---|---|---|
| 13.x | 33 | v3.2.0以上 | 12.0以上 | Android 12.0.0以上 | |
| 12.x | 32 | v3.1.2以上 | 11.0以上 | Android 10.1.2以上 | |
| 12.0 | 31 | v3.1.2以上 | 11.0以上 | Android 10.1.2以上 | |
| 11.0 | 30 | v3.1.0以上 | 10.0以上 | Android 10.1.1以上 | Monaca IDEの設定で、「Androidアプリの設定」から「AndroidXを有効にする」にチェックを入れる必要があります |
| 10.0 | 29 | v3.1.0以上 | 10.0以上 | Android 10.1.1以上 | ^ 上に同じ |
※ 併せて、Monaca 対応環境をご確認ください。（NIFCLOUDMB (ncmb-push-monaca-plugin)の保証動作環境ではありません。）
テクニカルサポート窓口では、1年半以内にリリースされたSDKに対してのみサポート対応させていただきます。
定期的なバージョンのアップデートにご協力ください。
※なお、mobile backend にて大規模な改修が行われた際は、1年半以内のSDKであっても対応出来ない場合がございます。
その際はinformationブログにてお知らせいたします。予めご了承ください。
- v3.1.2 ～ (※2023年10月時点)
開発ガイドラインをご覧ください。
- 詳細についてはドキュメントを併せてご確認ください.
- Android端末での利用には、ご自身のFirebase設定ファイルgoogle-services.jsonをダウンロードして、Cordovaプロジェクトのルートディレクトリに置く必要があります。設定ファイルのダウンロードについてはこちらのFirebaseサポートページにて詳細をご覧ください。
- Your_monaca_project/
platforms/
plugins/
www/
config.xml
google-services.json <--
...
ニフクラ mobile backendのデータストア(Installationクラス)にdeviceTokenを登録します。
- (String)applicationKey
- (String)clientKey
- (Function)successCallback() (OPTIONAL)
- (Function)errorCallback(error) (OPTIONAL)
アプリがプッシュ通知を受け取った際のコールバックを設定します。
- (function)callback(jsonData)
デバイスのinstallation objectIdを取得します。
- (function)callback(installationId)
プッシュ通知の開封状況をサーバーに登録する許可しますs。
登録した開封状況のデータにより管理画面にて統計グラフが表示されます。
- (Boolean) flag
- true : Send receipt to server
- false : No send
- (Function) callback() (OPTIONAL)
プッシュ通知の開封状況を取得します。
- (function)callback(flag)
デバイスのInstallation deviceTokenを取得します。
- (function)callback(deviceToken)
プッシュ通知の許可を付与します。
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<script src="cordova.js"></script>
<script>
document.addEventListener("deviceready", function() {
NCMB.monaca.setDeviceToken(
"#####application_key#####",
"#####client_key#####"
);
// Set callback for push notification data.
NCMB.monaca.setHandler(function(jsonData){
alert("callback :::" + JSON.stringify(jsonData));
});
// Get device token.
NCMB.monaca.getDeviceToken(function(deviceToken){
// something
});
// Get installation ID.
NCMB.monaca.getInstallationId(function(installationId){
// something
});
// Grant notification permission
window.NCMB.monaca.grantPermission(function(hasPermission){
console.log("Notifications permission was " + (hasPermission ? "granted" : "denied"));
});
// Get receipt status
NCMB.monaca.getReceiptStatus(function(status){
// status = true or false
});
// Set receipt status
NCMB.monaca.setReceiptStatus(true);
},false);
</script>
</head>
<body>
<h1>PushNotification Sample</h1>
</body>
</html>LICENSEファイルをご覧ください。
このプロジェクトに含まれるモジュール:
- Cordova plugin for Google Firebase (after_prepare.js):
- license: MIT
- Copyright (c) 2016 Robert Arnesson AB
- homepage: https://github.com/arnesson/cordova-plugin-firebase
- version: v1.0.5
- PhoneGap/Cordova 9.0 ~ Cordova 12.0
- iOS Support OS version:
- iOS 13.x ~ iOS 17.x
- Android Support OS version:
| Android | Android API level | NIFCLOUDMB (ncmb-push-monaca-plugin) |
Cordova | Build Environment Settings | Note |
|---|---|---|---|---|---|
| 13.x | 33 | v3.2.0 ~ | 12.0 ~ | Android 12.0.0 ~ | |
| 12.x | 32 | v3.1.2 ~ | 11.0 ~ | Android 10.1.2 ~ | |
| 12.0 | 31 | v3.1.2 ~ | 11.0 ~ | Android 10.1.2 ~ | |
| 11.0 | 30 | v3.1.0 ~ | 10.0 ~ | Android 10.1.1 ~ | Be sure to check the "Enable AndroidX" box in "Android App Settings" on Monaca IDE settings. |
| 10.0 | 29 | v3.1.0 ~ | 10.0 ~ | Android 10.1.1 ~ | ^ same as above |
※ For reference, please check Monaca Supported Environment （Notice: This is not an equal guarantee operation environment for the NIFCLOUDMB push plugin. ）
Please read Developer guidelines.
- v3.1.2 ～ (※as of October,2023)
- Check the following Japanese official document for details on setup.
- To use with Android devices, download your Firebase configuration file - google-services.json, and place them in the root folder of your Cordova project. Check out this Firebase article for details on how to download the files.
- Your_monaca_project/
platforms/
plugins/
www/
config.xml
google-services.json <--
...
Register device-token to NIFCLOUD mobile backend datastore (Installation class).
- (String)applicationKey
- (String)clientKey
- (Function)successCallback() (OPTIONAL)
- (Function)errorCallback(error) (OPTIONAL)
Set the callback when app receive a push notification.
- (function)callback(jsonData)
Get the Installation objectId for device.
- (function)callback(installationId)
Set the notification open receipt status to be store or not. This status will be used to create Push notification open status statistic graph.
- (Boolean) flag
- true : Send receipt to server
- false : No send
- (Function) callback() (OPTIONAL)
Get the notification open receipt status.
- (function)callback(flag)
Get the Installation deviceToken for device.
- (function)callback(deviceToken)
Grant the permission for push notification.
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<script src="cordova.js"></script>
<script>
document.addEventListener("deviceready", function() {
NCMB.monaca.setDeviceToken(
"#####application_key#####",
"#####client_key#####"
);
// Set callback for push notification data.
NCMB.monaca.setHandler(function(jsonData){
alert("callback :::" + JSON.stringify(jsonData));
});
// Get device token.
NCMB.monaca.getDeviceToken(function(deviceToken){
// something
});
// Get installation ID.
NCMB.monaca.getInstallationId(function(installationId){
// something
});
// Grant notification permission
window.NCMB.monaca.grantPermission(function(hasPermission){
console.log("Notifications permission was " + (hasPermission ? "granted" : "denied"));
});
// Get receipt status
NCMB.monaca.getReceiptStatus(function(status){
// status = true or false
});
// Set receipt status
NCMB.monaca.setReceiptStatus(true);
},false);
</script>
</head>
<body>
<h1>PushNotification Sample</h1>
</body>
</html>Please read LICENSE file.
Modules in this project:
- Cordova plugin for Google Firebase (after_prepare.js):
- license: MIT
- Copyright (c) 2016 Robert Arnesson AB
- homepage: https://github.com/arnesson/cordova-plugin-firebase
- version: v1.0.5