GcmNetworkManager

Class Overview

Clients will use this class to schedule tasks that require network access.

This uses a simple pattern of requests and callbacks that make it easy to set up clearly defined network task execution schedules.

Tasks must be scheduled based on an execution window in time. During this execution window the scheduler will use its discretion in picking an optimal execution time, based on network availability (whether the device has connectivity), network activity (whether packages are actively being transferred). and load (how many other pending tasks are available for execution at that point in time).

To receive the notification from the scheduler that a task is ready to be executed, the client app must implement a GcmTaskService and filter on the action ACTION_TASK_EVENT. The receivers must be registered in the manifest in order to wake up the application.

Similar to the pattern used in GoogleCloudMessaging, the service should be protected by the permission com.google.android.gms.permission.BIND_NETWORK_TASK_SERVICE held by Google Play services. This prevents other code from invoking the broadcast receiver. Here is an excerpt from a sample manifest:

 <service android:name=".MyUploadService" android:exported="true"
     android:permission="com.google.android.gms.permission.BIND_NETWORK_TASK_SERVICE" >
     <intent-filter>
        <action android:name="com.google.android.gms.gcm.ACTION_TASK_READY" />
     </intent-filter>
 </service>

A task event will have an associated state, and optionally any user-specified data given to the scheduler in the schedule request.

     // Schedule a task to occur between five and fifteen seconds from now:
     GcmNetworkManager.get(this)
                 .setService(MyUploadService.getClass())
                 .scheduleTask(5L, 15L, "upload");
     ...

     // Implement service logic to be notified when the task elapses:
     MyUploadService extends GcmTaskService {
         @Override
         public int onRunTask(String tag) {
             // Do some upload work.
             return GcmNetworkManager.RESULT_SUCCESS;
         }
     }
 

Summary

[Expand] Inherited Methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)