B4A Tutorial Android push notification (GCM) framework and tutorial

Discussion in 'Tutorials & Examples' started by Erel, Jul 3, 2012.

  1. Erel

    Erel Administrator Staff Member Licensed User

    Background

    Google provides a service named Google Cloud Message (GCM) which allows developers to send data to their applications running on Android devices. Unlike most solutions which involve polling some server, this service is a "push" service (similar to SMS messages).

    GCM replaces the previous service named C2DM. This framework is a modified version of the previous C2DM framework that works with the new service.
    Note that new GCM service is simpler than C2DM and doesn't require a special approval from Google.

    Developers should implement three components in order to use this service.
    Client code - The client code which is responsible for registering the specific device and application with Google service and is responsible for handling new messages that arrive.

    Web server - When the device registers with Google service it receives a registration id that allows you, the account holder, to send messages to your application running on the user device. The device needs to send this id to a web server that you can access.

    Messages sending tool - This is a command line tool that is responsible for fetching the user id from the web server and then sending the message to the device. This is done by sending a request to Google servers.

    The attached framework includes these components.
    It is recommended to read the formal documentation about GCM to better understand the flow: GCM Architectural Overview | Android Developers

    Configuration and installation instructions

    In order to use GCM service you need to get two values: API key and project id.
    This is done by following the steps mentioned here: GCM: Getting Started | Android Developers up until the "Install the Helper Libraries" section (there is no need to install anything).

    Client code
    In order to get it working, we will modify the device example application. Later you can integrate this code in your own application.
    1. SenderId variable should be set in the Main activity, under Sub Process_Globals to match project ID you previously received.

    2. You should add the following code to the manifest editor (this is already set in the attached example):
    Code:
    'C2DM Permissions
    AddManifestText(<permission android:name="$PACKAGE$.permission.C2D_MESSAGE" android:protectionLevel="signature" />)
    AddPermission($PACKAGE$.permission.C2D_MESSAGE)
    AddPermission(com.google.android.c2dm.permission.RECEIVE)
    ' Push Service Receiver Attribute
    SetReceiverAttribute(PushService, android:permission, "com.google.android.c2dm.permission.SEND")
    ' Service Receiver Text
    AddReceiverText(PushService,
    <
    intent-filter>
    <action android:name=
    "com.google.android.c2dm.intent.RECEIVE" />
    <category android:name=
    "$PACKAGE$" />
    </
    intent-filter>
    <
    intent-filter>
    <action android:name=
    "com.google.android.c2dm.intent.REGISTRATION" />
    <category android:name=
    "$PACKAGE$" />
    </
    intent-filter>)

    Sending messages desktop tool
    1. Open config.txt and update the api_key field.

    You are now ready to test it!
    Run the B4A project, enter a name in the text field and press on the Register button. You should see a toast message saying Registration successful. Messages are also printed to the logs. It can take several seconds.
    This means two things. Your device has registered with Google servers and also that the registration id was sent to the developer web service (currently configured with the service hosted here) with the specified name.
    The name will be used to reference the device. Note that each device must have a unique name.

    Now go to the command line tool folder and open a command window (this can be done by pressing Shift together with right clicking on the folder icon).
    The sending messages tool is a java app. For your convenience a batch file is included to run this tool. Note that this app can run from Linux or Mac as well.

    The sending tool expects several arguments:
    Code:
    send <device name> <message text> [<collapse_key> [<delay while sleeping>]]
    Device name is the name that you previously chose in the client app.
    Message text is the text that will be sent. Remember to wrap it with quotes if it contains spaces.
    The last two arguments are optional. See the formal documentation for more information about them.
    Instead of 'send' command, you can use 'SendTextFile'. It is the same as send, however the second argument is the path to a text file that will be sent.
    Another command is 'GetAll'. It will display all the registered device names (this command is not available in the web service hosted here.

    The command line tool can be automated. It returns an exit code of 0 if the operation succeeded and 1 otherwise.

    Try sending a message to your device. It should arrive to the device almost immediately.

    [​IMG]

    Note that the batch file name is b4a_gcm.bat.

    Handling of messages is done in Sub MessageArrived in PushService module.

    Web server configuration
    The device application and the sending messages tool are preconfigured to use the web server hosted here. This server should only be used during development.
    The web server is built from a PHP script which communicates with a MySQL database.
    In order to host it yourself, you should upload it to a server that supports PHP and create a database and user that is able to access the database.
    The script creates the table on the first run.
    You will need to edit the PHP script and set the database name / user / password.
    There are additional two passwords in this script: devicepassword and serverpassword. The device password should match the DeviceBoardPassword field in the device application and the serverpassword should match the server_password field in the sending messages tool configuration. Both these passwords should only contain letters and numbers.
    You should also change the board url value in the desktop tool and device app to match the location of your hosted php file.

    Another "push" solution that doesn't require an online server: http://www.basic4ppc.com/android/forum/threads/simple-push-framework.35635/
     

    Attached Files:

    Last edited: Dec 12, 2013
    caccas and Adro_Sydney like this.
  2. choliz

    choliz Member Licensed User

    Hi,

    When I try to compile the example, I get the following error:

    Compiling code. Error
    Error parsing program.
    Error description: Unknown type: reflector
    Are you missing a library reference?
    Occurred on line: 43
    Dim r As Reflector

    What am I missing?

    Thanks in advance
     
  3. NJDude

    NJDude Expert Licensed User

  4. choliz

    choliz Member Licensed User

    Damn it!

    Ok, I got it to compile and run on the emulator.

    Now two issues:

    1.- I dont see any ToastMessage saying that I got registered
    2.- When I try to send a message, Java complains that I am missing anywheresoftware.b4a.c2dm.C2DM

    Any ideas?

    Thanks in advance
     
  5. choliz

    choliz Member Licensed User

    Ok,

    I got it running on my Atrix4G. First I got an INVALID SENDER Toast Message, After changing the senderId to the email address used while creating the API Project, it was able to register.

    But I'm still getting the error that anywheresoftware.b4a.c2dm.C2DM can't be found whenever I try to send a message.

    Thanks in advance
     
  6. wes58

    wes58 Member Licensed User

    There is an error in the b4a_gcm.bat. You have to change jar file to b4a_gcm.jar
     
  7. cutstone

    cutstone Member Licensed User

    Thanks for the guide Erel.

    I just succeed changing my project from C2DM in to GCM - now it finally works. However, I did have some troubles to figure out what IDs to place where. Searching on the web gave me the answers, so in case others are struggling with the same issue, I'd like to share. From the C2DM-discussions, people had asked for native PHP code to send messages. I found a piece of code from Stackoverflow that serves my need.

    First issue was the SenderID. In the description was mentioned 'Project ID'. When I look the Google APIs Console/Dashboard, it states that Project ID is something like 'cutstone.dk:myproject'. This is not the project ID to user in the SenderID variable in your B4A code. Instead, look at the number in your browsers URL: It says something like /#project:523812998263. The 12-digit number is your SenderID.

    Next issue was the API-key. Googles documentation states you have to generate a Server Key as you API-key. That didn't work for me, but as mentioned several places on the web, Google might have a bug in the documentation. Instead the Browser key works for me.

    In my PHP-code, I call enclosed code to send a Push message to my phone device.

    This might be obvious for many of you guys, but for me it took quite some hours to figure out. BTW currently this PHP code sent an empty message. I didn't dig into this, because I just needed a Push message to know my device need to contact my server.
     

    Attached Files:

    Last edited: Jul 27, 2012
  8. Erel

    Erel Administrator Staff Member Licensed User

    Thank you for sharing this script.

    Fixed.
     
  9. mvpmedia

    mvpmedia Member Licensed User

    I got the same no message error. In the sendGCM file you need to change the fields array for data from "message" to "data" then it will shoot the message.
     
  10. eric010101

    eric010101 Member Licensed User

    Hi,Erel

    When I try to compile the example, I have some question:

    I can get the RegistrarID,but when i send to My server .It can`t Work!
    And then ,I used some GCM client example APP to My server.It`s Working!

    Your example like to use Registration by C2DM,not use GCM?

    In C2DM SenderID use Google Mail
    In GCM SenderID use Project ID(From the Google API console)

    Your example just can use Google Maill,can`t use Project ID

    And I have no idea to fix your example code:confused:
     
  11. Erel

    Erel Administrator Staff Member Licensed User

    This example is based on GCM not C2DM. As you write you should use the project id not gmail address.
     
  12. cutstone

    cutstone Member Licensed User

    Thank you for this correction. I have changed the previous uploaded script and reuploaded it with your tip.
     
  13. gordon

    gordon Member Licensed User

    I am still getting INVALID_SENDER despite entering the 12 digit key as shown in the browser url. Please :sign0085:
     
  14. Erel

    Erel Administrator Staff Member Licensed User

  15. gordon

    gordon Member Licensed User

    Aye, that bit is okay now, a number in the id was transposed, and it was a case of not being able to see it for all the looking I was doing.

    Now though, on running the command line tool I get the following :- could not find or load main class anywheresoftware.b4a.cdm.C2DM

    If anyone could solve that for me then I would be a grateful and happy bunny.
    Ty.
     
  16. Erel

    Erel Administrator Staff Member Licensed User

    Open the folder in a command line.
    First run "java -version". Make sure that you are using Java 6 or Java 7.
     
  17. gordon

    gordon Member Licensed User

    Java version tells me its ver7. Could it be because i do not have all the files in the right folder? It's not clear to me what folders they should be in, so I unzipped the three zip folders to individual folders.Is that correct?
     
  18. flyingbag

    flyingbag Member Licensed User

    Unzipping should not be the problem ...
    You should have a folder something like
    c:\yourfoldername\Device

    which contains all the .bat and .jar files.

    Start "cmd" - go to the above folder

    Then run the .bat file with the arguments given in the tutorial ... it should work.

    Assuming you have done the following:
    -you have registered on Google Console API
    - config.txt file has the right api key
    - B4a program has the correct project id
     
    Last edited: Aug 29, 2012
  19. gordon

    gordon Member Licensed User

    Well I must be making progress because now I get server response 401 for
    url https ://android.googleapis.com/gcm/send at anywheresoftware.b4a.c2dm.sendmessageto(C2DM.java:57)
    at anywheresoftware.b4a.c2dm.C2DM.main(C2DM.java:218)

    :sign0085:
     
  20. Erel

    Erel Administrator Staff Member Licensed User

Share This Page

Loading...