http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/642bf9ad/sdks/android/doc/org/usergrid/android/client/Client.html ---------------------------------------------------------------------- diff --git a/sdks/android/doc/org/usergrid/android/client/Client.html b/sdks/android/doc/org/usergrid/android/client/Client.html deleted file mode 100644 index beeba0c..0000000 --- a/sdks/android/doc/org/usergrid/android/client/Client.html +++ /dev/null @@ -1,2389 +0,0 @@ - - - -
- -
-
-
|
-- - | -|||||||||
- PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -|||||||||
- SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -
-java.lang.Object --org.usergrid.android.client.Client -
public class Client
-The Client class for accessing the Usergrid API. Start by instantiating this - class though the appropriate constructor. -
- -
-
-Nested Class Summary | -|
---|---|
-static interface |
-Client.Query
-
-- |
-
-static class |
-Client.QueuePosition
-
-- |
-
-Field Summary | -|
---|---|
-static boolean |
-FORCE_PUBLIC_API
-
-- |
-
-static java.lang.String |
-LOCAL_API_URL
-
-- |
-
-static java.lang.String |
-LOCAL_STANDALONE_API_URL
-
-- |
-
-static java.lang.String |
-LOCAL_TOMCAT_API_URL
-
-- |
-
-static java.lang.String |
-PUBLIC_API_URL
-
-- |
-
-Constructor Summary | -|
---|---|
Client()
-
-- Default constructor for instantiating a client. |
-|
Client(java.lang.String applicationId)
-
-- Instantiate client for a specific app |
-
-Method Summary | -||
---|---|---|
- ApiResponse |
-addSubscriber(java.lang.String publisherQueue,
- java.lang.String subscriberQueue)
-
-- |
-|
- ApiResponse |
-addUserToGroup(java.lang.String userId,
- java.lang.String groupId)
-
-- Adds a user to the specified groups. |
-|
- void |
-addUserToGroupAsync(java.lang.String userId,
- java.lang.String groupId,
- ApiResponseCallback callback)
-
-- Adds a user to the specified groups. |
-|
- ApiResponse |
-apiRequest(org.springframework.http.HttpMethod method,
- java.util.Map<java.lang.String,java.lang.Object> params,
- java.lang.Object data,
- java.lang.String... segments)
-
-- High-level Usergrid API request. |
-|
- ApiResponse |
-authorizeAppClient(java.lang.String clientId,
- java.lang.String clientSecret)
-
-- Log the app in with it's client id and client secret key. |
-|
- void |
-authorizeAppClientAsync(java.lang.String clientId,
- java.lang.String clientSecret,
- ApiResponseCallback callback)
-
-- Log the app in with it's client id and client secret key. |
-|
- ApiResponse |
-authorizeAppUser(java.lang.String email,
- java.lang.String password)
-
-- Log the user in and get a valid access token. |
-|
- void |
-authorizeAppUserAsync(java.lang.String email,
- java.lang.String password,
- ApiResponseCallback callback)
-
-- Log the user in and get a valid access token. |
-|
- ApiResponse |
-authorizeAppUserViaFacebook(java.lang.String fb_access_token)
-
-- Log the user in with their Facebook access token retrived via Facebook - OAuth. |
-|
- void |
-authorizeAppUserViaFacebookAsync(java.lang.String fb_access_token,
- ApiResponseCallback callback)
-
-- Log the user in with their numeric pin-code and get a valid access token. |
-|
- ApiResponse |
-authorizeAppUserViaPin(java.lang.String email,
- java.lang.String pin)
-
-- Log the user in with their numeric pin-code and get a valid access token. |
-|
- void |
-authorizeAppUserViaPinAsync(java.lang.String email,
- java.lang.String pin,
- ApiResponseCallback callback)
-
-- Log the user in with their numeric pin-code and get a valid access token. |
-|
- ApiResponse |
-connectEntities(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String connectedEntityId)
-
-- Connect two entities together. |
-|
- void |
-connectEntitiesAsync(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String connectedEntityId,
- ApiResponseCallback callback)
-
-- Connect two entities together. |
-|
- ApiResponse |
-createEntity(Entity entity)
-
-- Create a new entity on the server. |
-|
- ApiResponse |
-createEntity(java.util.Map<java.lang.String,java.lang.Object> properties)
-
-- Create a new entity on the server from a set of properties. |
-|
- void |
-createEntityAsync(Entity entity,
- ApiResponseCallback callback)
-
-- Create a new entity on the server. |
-|
- void |
-createEntityAsync(java.util.Map<java.lang.String,java.lang.Object> properties,
- ApiResponseCallback callback)
-
-- Create a new entity on the server from a set of properties. |
-|
- ApiResponse |
-createGroup(java.lang.String groupPath)
-
-- Creates a group with the specified group path. |
-|
- ApiResponse |
-createGroup(java.lang.String groupPath,
- java.lang.String groupTitle)
-
-- Creates a group with the specified group path and group title. |
-|
- void |
-createGroupAsync(java.lang.String groupPath,
- ApiResponseCallback callback)
-
-- Creates a group with the specified group path. |
-|
- void |
-createGroupAsync(java.lang.String groupPath,
- java.lang.String groupTitle,
- ApiResponseCallback callback)
-
-- Creates a group with the specified group path and group title. |
-|
- ApiResponse |
-createUser(java.lang.String username,
- java.lang.String name,
- java.lang.String email,
- java.lang.String password)
-
-- Creates a user. |
-|
- void |
-createUserAsync(java.lang.String username,
- java.lang.String name,
- java.lang.String email,
- java.lang.String password,
- ApiResponseCallback callback)
-
-- Creates a user. |
-|
- ApiResponse |
-disconnectEntities(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String connectedEntityId)
-
-- Disconnect two entities. |
-|
- void |
-disconnectEntitiesAsync(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String connectedEntityId,
- ApiResponseCallback callback)
-
-- Disconnect two entities. |
-|
- java.lang.String |
-getAccessToken()
-
-- |
-|
- java.lang.String |
-getApiUrl()
-
-- |
-|
- java.lang.String |
-getApplicationId()
-
-- |
-|
- java.lang.String |
-getClientId()
-
-- |
-|
- java.lang.String |
-getClientSecret()
-
-- |
-|
- java.lang.String |
-getCurrentOrganization()
-
-- |
-|
- java.util.Map<java.lang.String,Group> |
-getGroupsForUser(java.lang.String userId)
-
-- Get the groups for the user. |
-|
- void |
-getGroupsForUserAsync(java.lang.String userId,
- GroupsRetrievedCallback callback)
-
-- Get the groups for the user. |
-|
- User |
-getLoggedInUser()
-
-- |
-|
- ApiResponse |
-getMessages(java.lang.String path,
- java.lang.String consumer,
- java.util.UUID last,
- java.lang.Long time,
- java.lang.Integer prev,
- java.lang.Integer next,
- java.lang.Integer limit,
- Client.QueuePosition pos,
- java.lang.Boolean update,
- java.lang.Boolean sync)
-
-- |
-|
-
- |
-httpRequest(org.springframework.http.HttpMethod method,
- java.lang.Class<T> cls,
- java.util.Map<java.lang.String,java.lang.Object> params,
- java.lang.Object data,
- java.lang.String... segments)
-
-- Low-level HTTP request method. |
-|
- void |
-init()
-
-- |
-|
- ApiResponse |
-postGroupActivity(java.lang.String groupId,
- Activity activity)
-
-- Posts an activity to a group. |
-|
- ApiResponse |
-postGroupActivity(java.lang.String verb,
- java.lang.String title,
- java.lang.String content,
- java.lang.String category,
- User user,
- Entity object,
- java.lang.String objectType,
- java.lang.String objectName,
- java.lang.String objectContent)
-
-- Creates and posts an activity to a group. |
-|
- void |
-postGroupActivityAsync(java.lang.String verb,
- java.lang.String title,
- java.lang.String content,
- java.lang.String category,
- User user,
- Entity object,
- java.lang.String objectType,
- java.lang.String objectName,
- java.lang.String objectContent,
- ApiResponseCallback callback)
-
-- Creates and posts an activity to a group. |
-|
- ApiResponse |
-postMessage(java.lang.String path,
- java.util.List<java.util.Map<java.lang.String,java.lang.Object>> messages)
-
-- |
-|
- ApiResponse |
-postMessage(java.lang.String path,
- java.util.Map<java.lang.String,java.lang.Object> message)
-
-- |
-|
- ApiResponse |
-postUserActivity(java.lang.String userId,
- Activity activity)
-
-- Posts an activity to a user. |
-|
- ApiResponse |
-postUserActivity(java.lang.String verb,
- java.lang.String title,
- java.lang.String content,
- java.lang.String category,
- User user,
- Entity object,
- java.lang.String objectType,
- java.lang.String objectName,
- java.lang.String objectContent)
-
-- Creates and posts an activity to a user. |
-|
- void |
-postUserActivityAsync(java.lang.String verb,
- java.lang.String title,
- java.lang.String content,
- java.lang.String category,
- User user,
- Entity object,
- java.lang.String objectType,
- java.lang.String objectName,
- java.lang.String objectContent,
- ApiResponseCallback callback)
-
-- Creates and posts an activity to a user. |
-|
- Client.Query |
-queryActivityFeedForGroup(java.lang.String groupId)
-
-- Get a group's activity feed. |
-|
- void |
-queryActivityFeedForGroupAsync(java.lang.String groupId,
- QueryResultsCallback callback)
-
-- Get a group's activity feed. |
-|
- Client.Query |
-queryActivityFeedForUser(java.lang.String userId)
-
-- Get a user's activity feed. |
-|
- void |
-queryActivityFeedForUserAsync(java.lang.String userId,
- QueryResultsCallback callback)
-
-- Get a user's activity feed. |
-|
- Client.Query |
-queryEntitiesRequest(org.springframework.http.HttpMethod method,
- java.util.Map<java.lang.String,java.lang.Object> params,
- java.lang.Object data,
- java.lang.String... segments)
-
-- Perform a query request and return a query object. |
-|
- void |
-queryEntitiesRequestAsync(QueryResultsCallback callback,
- org.springframework.http.HttpMethod method,
- java.util.Map<java.lang.String,java.lang.Object> params,
- java.lang.Object data,
- java.lang.String... segments)
-
-- Perform a query request and return a query object. |
-|
- Client.Query |
-queryEntityConnections(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String ql)
-
-- Query the connected entities. |
-|
- void |
-queryEntityConnectionsAsync(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- java.lang.String ql,
- QueryResultsCallback callback)
-
-- Query the connected entities. |
-|
- Client.Query |
-queryEntityConnectionsWithinLocation(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- float distance,
- android.location.Location location,
- java.lang.String ql)
-
-- Query the connected entities within distance of a specific point. |
-|
- void |
-queryEntityConnectionsWithinLocationAsync(java.lang.String connectingEntityType,
- java.lang.String connectingEntityId,
- java.lang.String connectionType,
- float distance,
- android.location.Location location,
- java.lang.String ql,
- QueryResultsCallback callback)
-
-- Query the connected entities within distance of a specific point. |
-|
- Client.Query |
-queryQueuesRequest(org.springframework.http.HttpMethod method,
- java.util.Map<java.lang.String,java.lang.Object> params,
- java.lang.Object data,
- java.lang.String queuePath)
-
-- |
-|
- Client.Query |
-queryUsers()
-
-- Perform a query of the users collection. |
-|
- Client.Query |
-queryUsers(java.lang.String ql)
-
-- Perform a query of the users collection using the provided query command. |
-|
- void |
-queryUsersAsync(QueryResultsCallback callback)
-
-- Perform a query of the users collection. |
-|
- void |
-queryUsersAsync(java.lang.String ql,
- QueryResultsCallback callback)
-
-- Perform a query of the users collection using the provided query command. |
-|
- Client.Query |
-queryUsersForGroup(java.lang.String groupId)
-
-- Queries the users for the specified group. |
-|
- void |
-queryUsersForGroupAsync(java.lang.String groupId,
- QueryResultsCallback callback)
-
-- Queries the users for the specified group. |
-|
- void |
-queryUsersNearLocation(float distance,
- android.location.Location location,
- java.lang.String ql,
- QueryResultsCallback callback)
-
-- Perform a query of the users collection within the specified distance of - the specified location and optionally using the provided query command. |
-|
- Client.Query |
-queryUsersWithinLocation(float distance,
- android.location.Location location,
- java.lang.String ql)
-
-- Perform a query of the users collection within the specified distance of - the specified location and optionally using the provided query command. |
-|
- Device |
-registerDevice(android.content.Context context,
- java.util.Map<java.lang.String,java.lang.Object> properties)
-
-- Registers a device using the device's unique device ID. |
-|
- void |
-registerDeviceAsync(android.content.Context context,
- java.util.Map<java.lang.String,java.lang.Object> properties,
- DeviceRegistrationCallback callback)
-
-- Registers a device using the device's unique device ID. |
-|
- ApiResponse |
-removeSubscriber(java.lang.String publisherQueue,
- java.lang.String subscriberQueue)
-
-- |
-|
- void |
-setAccessToken(java.lang.String accessToken)
-
-- |
-|
- void |
-setApiUrl(java.lang.String apiUrl)
-
-- |
-|
- void |
-setApplicationId(java.lang.String applicationId)
-
-- |
-|
- void |
-setClientId(java.lang.String clientId)
-
-- |
-|
- void |
-setClientSecret(java.lang.String clientSecret)
-
-- |
-|
- void |
-setCurrentOrganization(java.lang.String currentOrganization)
-
-- |
-|
- void |
-setLoggedInUser(User loggedInUser)
-
-- |
-|
- Client |
-withApiUrl(java.lang.String apiUrl)
-
-- |
-|
- Client |
-withApplicationId(java.lang.String applicationId)
-
-- |
-|
- Client |
-withClientId(java.lang.String clientId)
-
-- |
-|
- Client |
-withClientSecret(java.lang.String clientSecret)
-
-- |
-
Methods inherited from class java.lang.Object | -
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
-
-Field Detail | -
---|
-public static boolean FORCE_PUBLIC_API-
-public static java.lang.String PUBLIC_API_URL-
-public static java.lang.String LOCAL_STANDALONE_API_URL-
-public static java.lang.String LOCAL_TOMCAT_API_URL-
-public static java.lang.String LOCAL_API_URL-
-Constructor Detail | -
---|
-public Client()-
-
-public Client(java.lang.String applicationId)-
-
applicationId
- the application id or name-Method Detail | -
---|
-public void init()-
-public java.lang.String getApiUrl()-
-public void setApiUrl(java.lang.String apiUrl)-
apiUrl
- the Usergrid API url (default: http://api.usergrid.com)-public Client withApiUrl(java.lang.String apiUrl)-
apiUrl
- the Usergrid API url (default: http://api.usergrid.com)
--public java.lang.String getApplicationId()-
-public void setApplicationId(java.lang.String applicationId)-
applicationId
- the application id or name-public Client withApplicationId(java.lang.String applicationId)-
applicationId
- the application id or name
--public java.lang.String getClientId()-
-public void setClientId(java.lang.String clientId)-
clientId
- the client key id for making calls as the application-owner.
- Not safe for most mobile use.-public Client withClientId(java.lang.String clientId)-
clientId
- the client key id for making calls as the application-owner.
- Not safe for most mobile use.
--public java.lang.String getClientSecret()-
-public void setClientSecret(java.lang.String clientSecret)-
clientSecret
- the client key id for making calls as the application-owner.
- Not safe for most mobile use.-public Client withClientSecret(java.lang.String clientSecret)-
clientSecret
- the client key id for making calls as the application-owner.
- Not safe for most mobile use.
--public User getLoggedInUser()-
-public void setLoggedInUser(User loggedInUser)-
loggedInUser
- the logged-in user, usually not set by host application-public java.lang.String getAccessToken()-
-public void setAccessToken(java.lang.String accessToken)-
accessToken
- an OAuth2 access token. Usually not set by host application-public java.lang.String getCurrentOrganization()-
-public void setCurrentOrganization(java.lang.String currentOrganization)-
currentOrganization
- -public <T> T httpRequest(org.springframework.http.HttpMethod method, - java.lang.Class<T> cls, - java.util.Map<java.lang.String,java.lang.Object> params, - java.lang.Object data, - java.lang.String... segments)-
-
method
- HttpMethod methodcls
- class for the return typeparams
- parameters to encode as querystring or body parametersdata
- JSON data to put in bodysegments
- REST url path segments (i.e. /segment1/segment2/segment3)
--public ApiResponse apiRequest(org.springframework.http.HttpMethod method, - java.util.Map<java.lang.String,java.lang.Object> params, - java.lang.Object data, - java.lang.String... segments)-
-
method
- params
- data
- segments
-
--public ApiResponse authorizeAppUser(java.lang.String email, - java.lang.String password)-
-
email
- password
-
--public void authorizeAppUserAsync(java.lang.String email, - java.lang.String password, - ApiResponseCallback callback)-
-
email
- password
- callback
- -public ApiResponse authorizeAppUserViaPin(java.lang.String email, - java.lang.String pin)-
-
email
- pin
-
--public void authorizeAppUserViaPinAsync(java.lang.String email, - java.lang.String pin, - ApiResponseCallback callback)-
-
email
- pin
- callback
- -public ApiResponse authorizeAppUserViaFacebook(java.lang.String fb_access_token)-
-
email
- pin
-
--public void authorizeAppUserViaFacebookAsync(java.lang.String fb_access_token, - ApiResponseCallback callback)-
-
email
- pin
- callback
- -public ApiResponse authorizeAppClient(java.lang.String clientId, - java.lang.String clientSecret)-
-
email
- pin
-
--public void authorizeAppClientAsync(java.lang.String clientId, - java.lang.String clientSecret, - ApiResponseCallback callback)-
-
clientId
- clientSecret
- callback
- -public Device registerDevice(android.content.Context context, - java.util.Map<java.lang.String,java.lang.Object> properties)-
-
context
- properties
-
--public void registerDeviceAsync(android.content.Context context, - java.util.Map<java.lang.String,java.lang.Object> properties, - DeviceRegistrationCallback callback)-
-
context
- properties
- callback
- -public ApiResponse createEntity(Entity entity)-
-
entity
-
--public void createEntityAsync(Entity entity, - ApiResponseCallback callback)-
-
entity
- callback
- -public ApiResponse createEntity(java.util.Map<java.lang.String,java.lang.Object> properties)-
-
properties
-
--public void createEntityAsync(java.util.Map<java.lang.String,java.lang.Object> properties, - ApiResponseCallback callback)-
-
properties
- callback
- -public ApiResponse createUser(java.lang.String username, - java.lang.String name, - java.lang.String email, - java.lang.String password)-
-
username
- requiredname
- email
- password
-
--public void createUserAsync(java.lang.String username, - java.lang.String name, -