‹ PhunwareMessaging Doc Home

Phunware Integration Guide（Messaging）

For the Lua version of cocos2d-x v3.x - (all other versions)

SDK Version

• ios: v3.0.2
• android: v3.0.4

Integration

Open a terminal and use the following command to install the SDKBOX Phunware Messaging plugin. Make sure you setup the SDKBOX installer correctly.

$ sdkbox import phunwaremessaging

Configure your app for push notifications (iOS)

1. Go to Apple developer portal and create a push notification certificate. (See Push notification tutorial for detailed instructions)

2. Once it's created, download the push production certificate and add it to Keychain Access. Then, from Keychain Access, export both the certificate and key. (Right click to view the Export option) as a .p12 and set a password.

3. Now, log on to the Maas Portal, navigate to the app created for your application and update the following.

   • Certificate (.p12): Click the grey ellipses button to upload the Production Push Certificate you created on developer.apple.com.
   • Password: The password you setup for the push certificate.
   • Environment: Use Sandbox for debug builds. Use Production environment for production apps and Production Ad-Hoc build.

Android Configuration

1. Phunware messaging currently only supports Android-Studio
2. Create a new Android application in MAAS-portal
3. In strings.xml (under Sample/src/main/res/values), replace the appId, accessKey and signatureKey with values for this application in MAAS portal.
4. Set up Google Cloud Messaging
5. Create a project on Firebase console
6. Choose 'Add Firebase to Android app'
7. In the Firebase console, the package name should be the same as application id in build.grade (under Sample directory)
8. In the MAAS portal, for the newly created Android app, replace the API Key and sender id with the values for ServerKey and SenderId on the Firebase console (under CloudMessaging section)
9. The Firebase console creates a google-services.json file and downloads it to your default Downloads folder.
10. Replace the default google-service.json file (under Sample directory) the sample app with the dowloaded google-service.json from Firebase console
11. Add the google-services gradle plugin to you applications gradle file apply plugin: 'com.google.gms.google-services'

Configure your app for push notifications (Android)

NOTE: PhunwareMessaing don't support Eclipse/Ant project

1. Set up GCM at https://developers.google.com/cloud-messaging/android/client

2. Create a project on Firebase console

   • Choose 'Add Firebase to Android app'
   • In the Firebase console, the package name should be the same as application id in build.grade
   • The Firebase console creates a google-services.json file and downloads it to your default Downloads folder.
   • Put the google-services.json file to proj.android-studio/app/ folder

Important Notice

Please make sure the following settings in your project to make the plugin work well.

Disable App Transport Security

Adding the following entry to the info.plist file:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

It should look like this:

Disable Bitcode support

You have to turn off Bitcode support. If you don't, cocos2d-x will fail to build.

Set your game requires full screen

If your game doesn't support all screen orientations, you will need to check Requires full screen in Xcode. If you do not, your app will fail Apple's submission process.

Whitelist canOpenURL function

This setting depends on what plugins are in your project. You may need to add the required entry to the info.plist, under LSApplicationQueriesSchemes.

JSON Configuration

SDKBOX Installer will automatically inject a sample configuration to your sdkbox_config.json, that you have to modify it before you can use it for your own app.

Here is an example of the PhunwareMessaging configuration.

{
    "ios": {
        "PhunwareMessaging":{
            "debug":true,
            "api_id":"1569",
            "access_key":"b49ea8dc7bdc4a056d51e8b72a8f3a575047a4aa",
            "signature_key":"b3f090e90cefe5b9535b0703d94a89a10f8a934b"
        }
    },
    "android": {
        "PhunwareMessaging":{
            "debug":true,
            "api_id":"1527",
            "access_key":"c11a65cb3deeca49aac6f8c0e794b7bc68e1481a",
            "signature_key":"1580b669f2edb1c810c29e52e9a754f443f6215a",
            "env":"dev"
        }
    }
}

Usage

Initialize PhunwareMessaging

• Modify your Lua code to init() the plugin. This can be done anyplace, however it must be done before trying to use the plugin's features.

sdkbox.PluginPhunwareMessaging:init()

Read message

// To use customized location
sdkbox.PluginPhunwareMessaging:read("123")

Remove message

sdkbox.PluginPhunwareMessaging:remove("123")

Get all messages

sdkbox.PluginPhunwareMessaging:messages()

Catch PhunwareMessaging events (optional)

This allows you to catch the PhunwareMessaging events so that you can perform operations such as providing player rewards for viewing ads.

• Create a listener (demonstrated by logging events):

sdkbox.PluginPhunwareMessaging:setListener(function(args)

    if "init" = args.event then
        print(args.event, args.success, args.message)
    elseif "error" = args.event then
        print(args.event, args.message)
    end

end)

API Reference

Methods

sdkbox.PluginPhunwareMessaging:init()

initialize the plugin instance.

sdkbox.PluginPhunwareMessaging:setListener(listener)

Set listener to listen for phunwaremessaging events

sdkbox.PluginPhunwareMessaging:read(messageID)

sdkbox.PluginPhunwareMessaging:remove(messageID)

sdkbox.PluginPhunwareMessaging:deviceId()

sdkbox.PluginPhunwareMessaging:serviceName()

sdkbox.PluginPhunwareMessaging:version()

sdkbox.PluginPhunwareMessaging:stop()

Listeners

init(success, message)

Notifies the delegate that the module has finished loading

error(message)

notification(notifi)

Manual Integration

If the SDKBOX Installer fails to complete successfully, it is possible to integrate SDKBOX manually. If the installer complete successfully, please do not complete anymore of this document. It is not necessary.

These steps are listed last in this document on purpose as they are seldom needed. If you find yourself using these steps, please, after completing, double back and re-read the steps above for other integration items.

Manual Integration For iOS

Drag and drop the following frameworks from the plugins/ios folder of the PhunwareAds bundle into your Xcode project

check Copy items if needed when adding frameworks:

sdkbox.framework

PluginPhunwareMessaging.framework

PWCore.framework

PWMessaging.framework

The above frameworks depend upon other frameworks. You also need to add the following system frameworks

if you don't already have them:

CoreLocation.framework

libz.tbd

libsqlite3.tbd

SystemConfiguration.framework

GameController.framework

MediaPlayer.framework

MobileCoreServices.framework

CoreTelephony.framework

Copy all source and header files from plugin/luabindings/ to your projects Classes folder.

Add these same files, that you just copied, to Xcode by either dragging and dropping them into Xcode or by using File -> Add files to....

Manual Integration For Android

SDKBOX supports three different kinds of Android projects command-line, eclipse and Android Studio.

• proj.android will be used as our <project_root> for command-line and eclipse project
• proj.android-studio will be used as our <project_root> for Android Studio project.

NOTE: not support eclipse project right now

Copy Files

Copy the following jar files from plugin/android/libs folder of this bundle into your project's /libs folder.

• If you're using cocos2d-x from source copy the jar files to:

  Android command-line: cocos2d/cocos/platform/android/java/libs

  Android Studio:

  cocos2d/cocos/platform/android/java/libs
  cocos2d/cocos/platform/android/libcocos2dx/libs
  

• If you're using cocos2d-js or lua copy the jar files to:

  Android command-line: frameworks/cocos2d-x/cocos/platform/android/java/libs

  Android Studio:

  frameworks/cocos2d-x/cocos/platform/android/java/libs
  frameworks/cocos2d-x/cocos/platform/android/libcocos2dx/libs
  

• If you're using prebuilt cocos2d-x copy the jar files to:

  Android command-line: proj.android/libs

Copy jni libs

Copy and overwrite all the folders from plugin/android/jni to your <project_root>/jni/ directory.

Edit AndroidManifest.xml

Include the following permissions above the application tag:

<uses-permission android:name="android.permission.INTERNET" />

To enable hardware acceleration in your application tag. This tag is optional on newer SDK versions and doesn't work on version 2.3.3.

<android:hardwareAccelerated="true" />

Edit Android.mk

Edit <project_root>/jni/Android.mk to:

Add additional requirements to LOCAL_WHOLE_STATIC_LIBRARIES:

LOCAL_WHOLE_STATIC_LIBRARIES += PluginPhunwareMessaging
LOCAL_WHOLE_STATIC_LIBRARIES += sdkbox

Add a call to:

$(call import-add-path,$(LOCAL_PATH))

before any import-module statements.

Add additional import-module statements at the end:

$(call import-module, ./sdkbox)
$(call import-module, ./pluginphunwaremessaging)

This means that your ordering should look similar to this:

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginphunwaremessaging)

Note: It is important to make sure these statements are above the existing $(call import-module,./prebuilt-mk) statement, if you are using the pre-built libraries.

Modify Application.mk (Cocos2d-x v3.0 to v3.2 only)

Edit <project_root>/jni/Application.mk to make sure APP_STL is defined correctly. If Application.mk contains APP_STL := c++_static, it should be changed to:

APP_STL := gnustl_static

Add APP_PATFORM version requirements:

APP_PLATFORM := android-16

Edit AndroidManifest.xml

Edit manifest. Example:

```
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="org.cocos2dx.cpp3141"
          xmlns:ns1="http://schemas.android.com/tools" <!-- ADD THIS LINE -->
          android:installLocation="auto" android:versionCode="1"
          android:versionName="1.0">
```

Edit application. Example:

```
<application android:icon="@drawable/icon"
             ns1:replace="android:label" <!-- ADD THIS LINE -->
             android:label="@string/app_name" >

    <!-- ADD START-->
    <activity android:name=".AppActivity">
        <intent-filter>
            <action android:name="android.intent.action.VIEW" />
            <category android:name="android.intent.category.DEFAULT" />
            <data android:mimeType="locationmessaging/message" />
        </intent-filter>
    </activity>
    <!-- ADD END-->

</application>
```

Edit build.gradle

Edit cocos2d/cocos/platform/android/libcocos2dx/build.gradle. Example:

```
...
android {
    compileSdkVersion 23                    # THIS LINE
    buildToolsVersion "23.0.3"              # THIS LINE
    useLibrary  'org.apache.http.legacy'    # THIS LINE


    defaultConfig {
        minSdkVersion 16                    # THIS LINE
        targetSdkVersion 22                 # THIS LINE
        versionCode 1
        versionName "1.0"
    }

    ...
}
...
```

Edit proj.android-studio/app/build.gradle

```
android {
+    compileSdkVersion 23
+    buildToolsVersion "23.0.3"
+    useLibrary  'org.apache.http.legacy'

     defaultConfig {
         applicationId "org.cocos2dx.cpp3141"   <!-- MUST SAME WITH google-services.json -->
+        minSdkVersion 16
         targetSdkVersion 22
         versionCode 1
         versionName "1.0"

         ...

     buildTypes {
+        debug {
+            ndk {
+                abiFilters = ["armeabi"]
+            }
+        }
+
         release {
+            ndk {
+                abiFilters = ["armeabi"]
+            }
+
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
             if (project.hasProperty("RELEASE_STORE_FILE")) {

             ...

 dependencies {
+    compile 'com.google.android.gms:play-services-maps:9.6.1'
+    compile 'com.android.support:appcompat-v7:23.3.0'
+    compile 'com.phunware.messaging:messaging:3.0.4'
     compile fileTree(dir: 'libs', include: ['*.jar'])
     compile project(':libcocos2dx')
 }

 clean.dependsOn cleanAssets
 preBuild.dependsOn copyAssets
+
+apply plugin: 'com.google.gms.google-services'
```

Edit proj.android-studio/build.gradle

```
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
+        classpath 'com.google.gms:google-services:3.0.0'
+
     }
 }

 allprojects {
     repositories {
         jcenter()
+        maven {
+            url "https://nexus.phunware.com/content/groups/public/"
+        }
     }
 }
```

Copy all source and header files from plugin/luabindings/ to your projects Classes folder.

Add all .cpp files, that you just copied, to Android.mk in the LOCAL_SRC_FILES section. Example

LOCAL_SRC_FILES := hellocpp/main.cpp \
                ../../Classes/AppDelegate.cpp \
                ../../Classes/HelloWorldScene.cpp \
                                ../../Classes/NewSourceFile.cpp

Modify AppActivity.java

Plugin >= 2.4.0.3

1. Find the AppActivity.java

find . -name "AppActivity.java"

1. Replace extends Cocos2dxActivity with extends com.sdkbox.plugin.SDKBoxActivity

Example of the directory where the AppActivity.java file is located:

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

Plugin < 2.4.0.3

• If you're using cocos2d-x from source, assuming you are in the proj.android directory, Cocos2dxActivity.java is located:

  ../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/ lib/Cocos2dxActivity.java

• If you're using the prebuilt cocos2d-x libraries assuming you are in the proj.android directory, Cocos2dxActivity.java is located:

  ./src/org/cocos2dx/lib/Cocos2dxActivity.java

Note: When using Cocos2d-x from source, different versions have Cocos2dxActivity.java in a different location. One way to find the location is to look in proj.android/project.properties. Example: android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

In this case, Cocos2dxActivity.java should be located at:

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java

• Modify Cocos2dxActivity.java to add the following imports:

import android.content.Intent;
import com.sdkbox.plugin.SDKBox;

• Second, modify Cocos2dxActivity.java to edit the onCreate(final Bundle savedInstanceState) function to add a call to SDKBox.init(this);. The placement of this call is important. It must be done after the call to onLoadNativeLibraries();. Example:

onLoadNativeLibraries();
SDKBox.init(this);

• Last, we need to insert the proper overrides code. There are a few rules here.

  • If the method listed has not been defined, add it.

  • If the method listed has been defined, add the calls to SDKBox in the same existing function.

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }

Proguard (optional)

• Edit project.properties to specify a Proguard configuration file. Example:

proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt

• Edit the file you specified to include the following:

# phunwaremessaging
-keep class * implements android.os.Parcelable {
    public static final android.os.Parcelable$Creator *;
}
-dontwarn okio.**
-dontwarn okhttp3.**


# cocos2d-x
-keep public class org.cocos2dx.** { *; }
-dontwarn org.cocos2dx.**
-keep public class com.chukong.** { *; }
-dontwarn com.chukong.**

# google play service
-keep public class com.google.android.gms.** { public *; }
-dontwarn com.google.android.gms.**

-keep class com.google.protobuf.** { *; }
-dontwarn com.google.protobuf.**

-keep class * extends java.util.ListResourceBundle {
    protected Object[][] getContents();
}

-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
    public static final *** NULL;
}

-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
    @com.google.android.gms.common.annotation.KeepName *;
}

-keepnames class * implements android.os.Parcelable {
    public static final ** CREATOR;
}

#sdkbox
-keep class com.sdkbox.** { *; }
-dontwarn com.sdkbox.**

Note: Proguard only works with Release builds (i.e cocos run -m release) debug builds do not invoke Proguard rules.

Notice

SDKBox PhunwareMessaging v3.5.1+ android Required:

1. Build SDK Version - 23
2. Compile SDK Version - 23

if you get miss HttpClient error when set build sdk to 23:

1. if use android studio, add this to your gradle:

android {
    useLibrary 'org.apache.http.legacy'
}