com.arubanetworks.meridian.campaigns

Class CampaignsService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

android.app.IntentService

com.arubanetworks.meridian.campaigns.CampaignsService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public class CampaignsService
extends android.app.IntentService

A background service for listening to Meridian campaigns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CampaignsService.RegisterCampaignsJobAgainEvent Internal class used by the campaigns jobScheduler.

Field Summary

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_INCLUDE_CAPABILITIES, BIND_NOT_FOREGROUND, BIND_NOT_PERCEPTIBLE, BIND_WAIVE_PRIORITY, BIOMETRIC_SERVICE, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, CROSS_PROFILE_APPS_SERVICE, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, EUICC_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, IPSEC_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, ROLE_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_RTT_RANGING_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
CampaignsService() Constructs the default CampaignService.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDeviceId(android.content.Context context) Returns a UUID associated with this device.
protected static void	jobFinished(android.content.Context context, EditorKey appKey, boolean lowLatency) Internal function used by the campaigns jobScheduler.
protected void	onHandleIntent(android.content.Intent intent)
void	onRegisterCampaignsJobAgainEvent(CampaignsService.RegisterCampaignsJobAgainEvent event) Internal function used by the campaigns jobScheduler.
static void	resetAllCampaigns(android.content.Context context, EditorKey appKey, MeridianRequest.Listener<java.lang.Void> listener, MeridianRequest.ErrorListener errorListener) Resets local campaigns cache as well as server side campaign cache.
static void	resetCampaign(android.content.Context context, EditorKey appKey, java.lang.String campaignId, MeridianRequest.Listener<java.lang.Void> listener, MeridianRequest.ErrorListener errorListener) Resets local campaigns cache as well as server side campaign cache for a single campaign.
static void	startMonitoring(android.content.Context context, EditorKey appKey) Starts monitoring for new campaign events, if you intend to handle campaign notifications this method should be called either in an on boot handler or each time your application starts.
static void	stopMonitoring(android.content.Context context) Stops monitoring for Campaign notifications.
static void	stopMonitoring(android.content.Context context, boolean clearCache) Stops monitoring for Campaign notifications.

Methods inherited from class android.app.IntentService

onBind, onCreate, onDestroy, onStart, onStartCommand, setIntentRedelivery

Methods inherited from class android.app.Service

dump, getApplication, getForegroundServiceType, onConfigurationChanged, onLowMemory, onRebind, onTaskRemoved, onTrimMemory, onUnbind, startForeground, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindIsolatedService, bindService, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainExecutor, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getOpPackageName, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver, updateServiceGroup

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CampaignsService

public CampaignsService()

Constructs the default CampaignService.

Method Detail

startMonitoring

public static void startMonitoring(@NonNull
                                   android.content.Context context,
                                   @NonNull
                                   EditorKey appKey)

Starts monitoring for new campaign events, if you intend to handle campaign notifications this method should be called either in an on boot handler or each time your application starts.

stopMonitoring

public static void stopMonitoring(@NonNull
                                  android.content.Context context)

Stops monitoring for Campaign notifications.

stopMonitoring

public static void stopMonitoring(@NonNull
                                  android.content.Context context,
                                  boolean clearCache)

Stops monitoring for Campaign notifications.

Parameters:

clearCache - If true all data cached for this service will be cleared.

resetAllCampaigns

public static void resetAllCampaigns(@NonNull
                                     android.content.Context context,
                                     @NonNull
                                     EditorKey appKey,
                                     MeridianRequest.Listener<java.lang.Void> listener,
                                     MeridianRequest.ErrorListener errorListener)

Resets local campaigns cache as well as server side campaign cache. The campaign service will stop and must be restarted after this call completes.

resetCampaign

public static void resetCampaign(@NonNull
                                 android.content.Context context,
                                 @NonNull
                                 EditorKey appKey,
                                 @NonNull
                                 java.lang.String campaignId,
                                 MeridianRequest.Listener<java.lang.Void> listener,
                                 MeridianRequest.ErrorListener errorListener)

Resets local campaigns cache as well as server side campaign cache for a single campaign. The campaign service will stop and must be restarted after this call completes.

onHandleIntent

protected void onHandleIntent(android.content.Intent intent)

Specified by:

onHandleIntent in class android.app.IntentService

getDeviceId

public static java.lang.String getDeviceId(android.content.Context context)

Returns a UUID associated with this device. Used internally for backend synchronization. For internal use only.

onRegisterCampaignsJobAgainEvent

public void onRegisterCampaignsJobAgainEvent(CampaignsService.RegisterCampaignsJobAgainEvent event)

Internal function used by the campaigns jobScheduler. For internal use only

jobFinished

protected static void jobFinished(@NonNull
                                  android.content.Context context,
                                  @NonNull
                                  EditorKey appKey,
                                  boolean lowLatency)

Internal function used by the campaigns jobScheduler. For internal use only