com.swirl

Class API

java.lang.Object

com.swirl.API

public class API
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	API.Completion
static class	API.DataCompletion
static class	API.ImageCompletion
static class	HttpClient.AuthInfo
static class	HttpClient.HttpCompletion
static class	HttpClient.HttpDataCompletion
static class	HttpClient.HttpImageCompletion
static class	HttpClient.HttpJSONCompletion

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_DISABLED
static int	ERROR_PARAMETERS
static int	ERROR_TIMEOUT
static int	ERROR_UNKNOWN
static java.lang.String	LAST_ACCCESS_CODE
static java.lang.String	PARTNER_NAME
protected java.util.concurrent.Executor	responseExecutor

Method Summary

Modifier and Type	Method and Description
void	authenticate(API.Completion completion)
void	beacon(java.lang.String identifier, java.lang.String extra, int rssi, API.Completion completion)
void	clearLocationLock(API.Completion completion)
void	content(java.lang.String type, Location location, long locationDwell, long placementDwell, long placementEnter, API.Completion completion)
void	content(android.net.Uri.Builder contentURL, org.json.JSONObject post, API.Completion completion)
void	dataRequest(java.lang.String url, org.json.JSONObject body, API.DataCompletion completion)
void	dataRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, org.json.JSONObject body, HttpClient.AuthInfo auth, HttpClient.HttpDataCompletion response)
void	flush(boolean wait)
void	flushEvents()
java.lang.String	getAPIHost()
java.lang.String	getAPIKey()
java.lang.String	getCDNHost()
void	getData(java.lang.String identifier, API.DataCompletion completion)
org.json.JSONObject	getDeviceInfo()
java.util.concurrent.ScheduledExecutorService	getExecutor() Return the 'swirl-thread' scheduled executor service
void	getImage(java.lang.String identifier, API.ImageCompletion completion)
void	getImageURL(java.lang.String url, API.ImageCompletion completion)
static API	getInstance() Return the shared singleton, assuming it has already been created.
static API	getInstance(android.content.Context c) Return the shared singleton, assuming it has already been created.
java.lang.String	getLatitude()
java.lang.String	getLongitude()
java.lang.String	getPartnerName()
java.lang.String	getPushAuthority()
java.lang.String	getPushIdentifier()
java.lang.String	getPushService()
java.util.concurrent.Executor	getResponseExecutor()
org.json.JSONObject	getUserInfo()
java.lang.String	getUserKey()
void	imageRequest(java.lang.String url, org.json.JSONObject body, API.ImageCompletion completion)
void	imageRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, org.json.JSONObject body, HttpClient.AuthInfo auth, HttpClient.HttpImageCompletion response)
void	logEvent(java.lang.String event, java.lang.String data)
void	makeRequest(java.lang.String url, java.util.HashMap<java.lang.String,java.lang.String> headers, byte[] body, API.Completion completion)
void	makeRequest(java.lang.String url, org.json.JSONObject body, API.Completion completion)
void	makeRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, byte[] body, HttpClient.AuthInfo auth, HttpClient.HttpCompletion completion)
void	makeRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, org.json.JSONObject body, HttpClient.AuthInfo auth, HttpClient.HttpJSONCompletion response)
void	makeRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String body, HttpClient.AuthInfo auth, HttpClient.HttpCompletion completion)
void	ping()
void	processDeferred()
void	regions(double latitude, double longitude, API.Completion completion)
void	reset()
void	setResponseExecutor(java.util.concurrent.Executor executor)
void	settings(API.Completion completion)
void	setUserInfo(org.json.JSONObject info)
void	start(android.os.Bundle options, API.Completion completion)
void	uploadImage(java.lang.String partner, android.graphics.Bitmap image, API.Completion completion)
void	wifi(java.lang.String identifier, int rssi, API.Completion completion)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

See Also:

Constant Field Values

ERROR_TIMEOUT

public static final int ERROR_TIMEOUT

See Also:

Constant Field Values

ERROR_DISABLED

public static final int ERROR_DISABLED

See Also:

Constant Field Values

ERROR_PARAMETERS

public static final int ERROR_PARAMETERS

See Also:

Constant Field Values

PARTNER_NAME

public static final java.lang.String PARTNER_NAME

See Also:

Constant Field Values

LAST_ACCCESS_CODE

public static final java.lang.String LAST_ACCCESS_CODE

See Also:

Constant Field Values

responseExecutor

protected java.util.concurrent.Executor responseExecutor

Method Detail

getInstance

public static API getInstance()

Return the shared singleton, assuming it has already been created. This flavor of the API will not create the shared instance if it does not already exist.

Returns:

API singleton or null if not already created.

getInstance

public static API getInstance(android.content.Context c)

Return the shared singleton, assuming it has already been created. If the instance has not yet been created, it will be created with default parameters (ie. all standard listeners).

Parameters:

c - Application context

Returns:

API singleton

getExecutor

public java.util.concurrent.ScheduledExecutorService getExecutor()

Return the 'swirl-thread' scheduled executor service

processDeferred

public void processDeferred()

start

public void start(android.os.Bundle options,
                  API.Completion completion)

getAPIKey

public java.lang.String getAPIKey()

getAPIHost

public java.lang.String getAPIHost()

getCDNHost

public java.lang.String getCDNHost()

getUserKey

public java.lang.String getUserKey()

getUserInfo

public org.json.JSONObject getUserInfo()

setUserInfo

public void setUserInfo(org.json.JSONObject info)

getDeviceInfo

public org.json.JSONObject getDeviceInfo()

getLatitude

public java.lang.String getLatitude()

getLongitude

public java.lang.String getLongitude()

getPushAuthority

public java.lang.String getPushAuthority()

getPushService

public java.lang.String getPushService()

getPushIdentifier

public java.lang.String getPushIdentifier()

makeRequest

public void makeRequest(java.lang.String url,
                        org.json.JSONObject body,
                        API.Completion completion)

makeRequest

public void makeRequest(java.lang.String url,
                        java.util.HashMap<java.lang.String,java.lang.String> headers,
                        byte[] body,
                        API.Completion completion)

dataRequest

public void dataRequest(java.lang.String url,
                        org.json.JSONObject body,
                        API.DataCompletion completion)

imageRequest

public void imageRequest(java.lang.String url,
                         org.json.JSONObject body,
                         API.ImageCompletion completion)

getPartnerName

public java.lang.String getPartnerName()

authenticate

public void authenticate(API.Completion completion)

settings

public void settings(API.Completion completion)

regions

public void regions(double latitude,
                    double longitude,
                    API.Completion completion)

ping

public void ping()

wifi

public void wifi(java.lang.String identifier,
                 int rssi,
                 API.Completion completion)

beacon

public void beacon(java.lang.String identifier,
                   java.lang.String extra,
                   int rssi,
                   API.Completion completion)

content

public void content(android.net.Uri.Builder contentURL,
                    org.json.JSONObject post,
                    API.Completion completion)

content

public void content(java.lang.String type,
                    Location location,
                    long locationDwell,
                    long placementDwell,
                    long placementEnter,
                    API.Completion completion)

logEvent

public void logEvent(java.lang.String event,
                     java.lang.String data)

flushEvents

public void flushEvents()

flush

public void flush(boolean wait)

clearLocationLock

public void clearLocationLock(API.Completion completion)

getData

public void getData(java.lang.String identifier,
                    API.DataCompletion completion)

getImageURL

public void getImageURL(java.lang.String url,
                        API.ImageCompletion completion)

getImage

public void getImage(java.lang.String identifier,
                     API.ImageCompletion completion)

uploadImage

public void uploadImage(java.lang.String partner,
                        android.graphics.Bitmap image,
                        API.Completion completion)

reset

public void reset()

setResponseExecutor

public void setResponseExecutor(java.util.concurrent.Executor executor)

getResponseExecutor

public java.util.concurrent.Executor getResponseExecutor()

makeRequest

public void makeRequest(java.lang.String url,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        byte[] body,
                        HttpClient.AuthInfo auth,
                        HttpClient.HttpCompletion completion)

makeRequest

public void makeRequest(java.lang.String url,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        java.lang.String body,
                        HttpClient.AuthInfo auth,
                        HttpClient.HttpCompletion completion)

makeRequest

public void makeRequest(java.lang.String url,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        org.json.JSONObject body,
                        HttpClient.AuthInfo auth,
                        HttpClient.HttpJSONCompletion response)

imageRequest

public void imageRequest(java.lang.String url,
                         java.util.Map<java.lang.String,java.lang.String> headers,
                         org.json.JSONObject body,
                         HttpClient.AuthInfo auth,
                         HttpClient.HttpImageCompletion response)

dataRequest

public void dataRequest(java.lang.String url,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        org.json.JSONObject body,
                        HttpClient.AuthInfo auth,
                        HttpClient.HttpDataCompletion response)