com.amazonaws.mobileconnectors.util

Class ClientContext

java.lang.Object

com.amazonaws.mobileconnectors.util.ClientContext

public class ClientContext
extends Object

A class that consists of app info, device info, additional service info, and user defined data.

 
 ClientContext clientContext = new ClientContext(activity);

 Map<String, String> map = new HashMap<String, String>();
 map.put("first_name", "John");
 map.put("last_name", "Doe");
 clientContext.putCustomContext(map);

 clientContext.putServiceContext("mobile_analytics", serviceContext);

 String base64 = clientContext.toBase64String();
 
 

Constructor Summary

Constructors

Constructor and Description
ClientContext(android.content.Context context) Constructs a new client context.

Method Summary

Modifier and Type	Method and Description
static String	getInstallationId(android.content.Context context) Gets the installation id from shared preferences.
void	putCustomContext(Map<String,String> map) Adds additional user defined key-value pairs to the client context under "custom".
void	putServiceContext(String service, Map<String,String> map) Sets service context under key "services".
String	toBase64String() Serializes the client context into a base64 encoded Json string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientContext

public ClientContext(android.content.Context context)

Constructs a new client context.

Parameters:

context - context of the app

Method Detail

getInstallationId

public static String getInstallationId(android.content.Context context)

Gets the installation id from shared preferences. A new one will be assigned if not found. The installation id is unique per app installation. This value appears as installation_id in client context object in AWS Lambda.

Parameters:

context - context of the app

Returns:

the unique installation id per app installation

See Also:

The Context Object (Node.js)

putCustomContext

public void putCustomContext(Map<String,String> map)

Adds additional user defined key-value pairs to the client context under "custom". This method is not thread safe.

 
 Map<String, String> map = new HashMap<String, String>();
 map.put("first_name", "John");
 map.put("last_name", "Doe");
 clientContext.putCustomContext(map);
 
 

The above code will add a Json object under "custom" as following.

 {
   "custom": {
     "first_name":"John",
     "last_name":"Doe"
   }
 }
 

Parameters:

map - the custom key-value context map

putServiceContext

public void putServiceContext(String service,
                              Map<String,String> map)

Sets service context under key "services". This will overwrite the service context of the same service name. This method isn't thread safe.

 {
   "services": {
     "mobile_analytics": {
       "app_id":"mobile_analytics_app_id"
     }
   }
 }
 

Parameters:

service - service name

map - the service key-value context map

toBase64String

public String toBase64String()

Serializes the client context into a base64 encoded Json string.

Returns:

a based64 encoded Json string