com.captainup.android.core

Interface AuthenticatedCaptainUpConnection

All Superinterfaces:

CaptainUpConnection

public interface AuthenticatedCaptainUpConnection
extends CaptainUpConnection

Method Summary

Modifier and Type	Method and Description
CreateAcquireCaptainUpResponse	acquire(Asset asset) Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener.
void	acquireAsync(Asset asset, CaptainUpCallback<CreateAcquireCaptainUpResponse> callback) Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener.
CreateClaimCaptainUpResponse	claimReward(Badge badge) See claimRewardAsync(Badge, CaptainUpCallback) about details on the claim operation.
CreateClaimCaptainUpResponse	claimReward(Badge badge, Reward reward)
void	claimRewardAsync(Badge badge, CaptainUpCallback<CreateClaimCaptainUpResponse> callback) Claim a reward from a Badge with reward (has its hasReward() function returns true).
void	claimRewardAsync(Badge badge, Reward reward, CaptainUpCallback<CreateClaimCaptainUpResponse> callback)
CreateActionCaptainUpResponse	createAction(Action action) See createActionAsync(Action, CaptainUpCallback) about details on the create action operation.
void	createActionAsync(Action action, CaptainUpCallback<CreateActionCaptainUpResponse> callback) Creates a new action and adds it to your app.
GetActionCaptainUpResponse	deleteNotifications(ActionType actionType, Query query) Removes notifications of the specified type (private or inbox) – either all notifications, or only a specified number.
GetActionCaptainUpResponse	deleteNotifications(ActionType actionType, Query query, java.lang.String messageID) Removes a specific notification of the specified type (private or inbox) – either all notifications, or only a specified number.
void	deleteNotificationsAsync(ActionType actionType, Query query, CaptainUpCallback<GetActionCaptainUpResponse> callback) Removes notifications of the specified type (private or inbox) – either all notifications, or only a specified number.
void	deleteNotificationsAsync(ActionType actionType, Query query, java.lang.String messageID, CaptainUpCallback<GetActionCaptainUpResponse> callback) Removes a specific notification of the specified type (private or inbox) – either all notifications, or only a specified number.
GetActionCaptainUpResponse	queryActions(ActionType actionType, Query query) Returns several actions and information about the users associated with them.
void	queryActionsAsync(ActionType actionType, Query query, CaptainUpCallback<GetActionCaptainUpResponse> callback) Returns several actions and information about the users associated with them.
GetActionCaptainUpResponse	queryUnreadInbox() Retrieves the notification list by their type.
void	queryUnreadInboxAsync(CaptainUpCallback<GetActionCaptainUpResponse> callback) Retrieves the notification list by their type.
void	setListener(SocketNotificationsListener listener) Used to listen to notification events from actions (used by framework

Methods inherited from interface com.captainup.android.core.CaptainUpConnection

addOrUpdateIntegrationUser, addOrUpdateIntegrationUserAsync, authenticate, queryActions, queryActionsAsync, queryLeaderboard, queryLeaderboardAsync, querySocialFeed, querySocialFeedAsync, retrieveApplication, retrieveApplicationAsync, retrieveUser, retrieveUserAsync, setLanguageCode

Method Detail

createAction

CreateActionCaptainUpResponse createAction(Action action)
                                    throws CaptainUpException

See createActionAsync(Action, CaptainUpCallback) about details on the create action operation.

Parameters:

action - the action to create. The action can be obtained using ActionBuilder.

Returns:

a response object that may either contain an error code or the changed objects from the operation.

Throws:

CaptainUpException

createActionAsync

void createActionAsync(Action action,
                       CaptainUpCallback<CreateActionCaptainUpResponse> callback)

Creates a new action and adds it to your app. When you create new actions, several things happen:

• The user the action is associated with, and other users, may receive points from doing this action, based on the action settings.
• The user may get promoted to a new level because of the points he or she received from the action.
• The user might achieve a badges, or multiple badges.
• When one of these things happen, it will be reported in the response.

This method is preferred over createAction(Action) since this will not block the current thread until the request returns.

Parameters:

action - the action to create. The action can be obtained using ActionBuilder.

callback - a callback that will contain the response and any exception that might have risen during the execution. The response may contain an erro code or the changes objects from the operation.

claimReward

CreateClaimCaptainUpResponse claimReward(Badge badge)
                                  throws CaptainUpException

See claimRewardAsync(Badge, CaptainUpCallback) about details on the claim operation.

Parameters:

badge - the badge with the reward to claim. (Must be a badge with a reward.) Badge.

Returns:

a response object that may either contain an error code or the changed objects from the operation.

Throws:

CaptainUpException

claimReward

CreateClaimCaptainUpResponse claimReward(Badge badge,
                                         Reward reward)
                                  throws CaptainUpException

Throws:

CaptainUpException

claimRewardAsync

void claimRewardAsync(Badge badge,
                      CaptainUpCallback<CreateClaimCaptainUpResponse> callback)

Claim a reward from a Badge with reward (has its hasReward() function returns true). Once a reward is claimed, it cannot be claimed again (will result in a callback error) callback will contain the claimed reward (you can use callback.getRewards() function). This method is asynchronous.

Parameters:

badge - badge with reward to be claimed

callback - response listener

claimRewardAsync

void claimRewardAsync(Badge badge,
                      Reward reward,
                      CaptainUpCallback<CreateClaimCaptainUpResponse> callback)

acquire

CreateAcquireCaptainUpResponse acquire(Asset asset)

Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener. in some cases (for example when user does not have enough currency or stock is limited) call will return an error, you can listen to error events to catch that error, or supply a callback. This method is asynchronous.

Parameters:

asset - The Asset to acquire

Returns:

response

acquireAsync

void acquireAsync(Asset asset,
                  CaptainUpCallback<CreateAcquireCaptainUpResponse> callback)

Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener. in some cases (for example when user does not have enough currency or stock is limited) call will return an error. This method is asynchronous.

Parameters:

asset - Asset to acquire

callback - callback

queryActions

GetActionCaptainUpResponse queryActions(ActionType actionType,
                                        Query query)
                                 throws CaptainUpException

Returns several actions and information about the users associated with them. Can return any type of actions for the authenticated user.

Parameters:

actionType - the type of action

query - query parameters

Returns:

a response object that may either contain an error code or the list of requested actions

Throws:

CaptainUpException

queryActionsAsync

void queryActionsAsync(ActionType actionType,
                       Query query,
                       CaptainUpCallback<GetActionCaptainUpResponse> callback)

Returns several actions and information about the users associated with them. Can return any type of actions for the authenticated user. This method is preferred over queryActions since this will not block the current thread until the request returns.

Parameters:

actionType - the type of the action

query - query parameters. To create a query object use QueryBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

See Also:

queryActions(ActionType, Query)

queryUnreadInbox

GetActionCaptainUpResponse queryUnreadInbox()
                                     throws CaptainUpException

Retrieves the notification list by their type.

Returns:

a response object that may either contain an error code or the list of requested actions

Throws:

CaptainUpException

java.lang.IllegalArgumentException - if the actionType is PUBLIC

queryUnreadInboxAsync

void queryUnreadInboxAsync(CaptainUpCallback<GetActionCaptainUpResponse> callback)

Retrieves the notification list by their type. This method is preferred over queryUnreadInbox() since this will not block the current thread until the request returns.

Parameters:

callback - a callback that will contain the response and any exception that might have risen during the execution.

Throws:

java.lang.IllegalArgumentException - if the actionType is PUBLIC

deleteNotifications

GetActionCaptainUpResponse deleteNotifications(ActionType actionType,
                                               Query query)
                                        throws CaptainUpException

Removes notifications of the specified type (private or inbox) – either all notifications, or only a specified number.

Parameters:

actionType - the requested notification's type. They only allowed values are ActionType.PRIVATE and ActionType.INBOX - it is not possible to delete only the public notifications. Private notifications also include the public ones.

query - query parameters. To create a query object use QueryBuilder

Returns:

a response object that may either contain an error code or the list of remaining notifications of the given type.

Throws:

CaptainUpException

java.lang.IllegalArgumentException - if the actionType is PUBLIC

deleteNotificationsAsync

void deleteNotificationsAsync(ActionType actionType,
                              Query query,
                              CaptainUpCallback<GetActionCaptainUpResponse> callback)

Removes notifications of the specified type (private or inbox) – either all notifications, or only a specified number. This method is preferred over deleteNotifications(ActionType, Query) since this will not block the current thread until the request returns.

Parameters:

actionType - the requested notification's type. They only allowed values are ActionType.PRIVATE and ActionType.INBOX - it is not possible to delete only the public notifications. Private notifications also include the public ones.

query - query parameters. To create a query object use QueryBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

deleteNotifications

GetActionCaptainUpResponse deleteNotifications(ActionType actionType,
                                               Query query,
                                               java.lang.String messageID)
                                        throws CaptainUpException

Removes a specific notification of the specified type (private or inbox) – either all notifications, or only a specified number.

Parameters:

actionType - the requested notification's type. They only allowed values are ActionType.PRIVATE and ActionType.INBOX - it is not possible to delete only the public notifications. Private notifications also include the public ones.

query - query parameters. To create a query object use QueryBuilder

messageID - the ID of the notification to delete Action.getID()

Returns:

a response object that may either contain an error code or the list of remaining notifications of the given type.

Throws:

CaptainUpException

java.lang.IllegalArgumentException - if the actionType is PUBLIC

deleteNotificationsAsync

void deleteNotificationsAsync(ActionType actionType,
                              Query query,
                              java.lang.String messageID,
                              CaptainUpCallback<GetActionCaptainUpResponse> callback)

Removes a specific notification of the specified type (private or inbox) – either all notifications, or only a specified number. This method is preferred over deleteNotifications(ActionType, Query) since this will not block the current thread until the request returns.

Parameters:

actionType - the requested notification's type. They only allowed values are ActionType.PRIVATE and ActionType.INBOX - it is not possible to delete only the public notifications. Private notifications also include the public ones.

query - query parameters. To create a query object use QueryBuilder

messageID - the ID of the notification to delete Action.getID()

callback - a callback that will contain the response and any exception that might have risen during the execution.

setListener

void setListener(SocketNotificationsListener listener)

Used to listen to notification events from actions (used by framework

Parameters:

listener -