com.fryd.sdk.service

Class FrydAPIService

java.lang.Object

com.fryd.sdk.service.AbstractFrydAPIService

com.fryd.sdk.service.FrydAPIService

public class FrydAPIService
extends AbstractFrydAPIService

Main Service to get everything you need from the fryd API.

Field Summary

Fields inherited from class com.fryd.sdk.service.AbstractFrydAPIService

BASE_API_URL, logger, oauthService

Constructor Summary

Constructors

Constructor and Description
FrydAPIService(com.github.scribejava.core.oauth.OAuth20Service oauthService, java.lang.String baseAPIUrl)

Method Summary

Modifier and Type	Method and Description
APIResponse<Location>	getFrydSpotById(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId) Gets the Location Information (also called fryd Spot Information) that is part of your Account
java.util.concurrent.Future<APIResponse<Location>>	getFrydSpotByIdAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId) Gets Location Information (also called fryd Spot Information) that is part of your Account in an asynchronous way
APIResponse<java.util.List<Trophy>>	getTrophiesOfList(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String trophylistId) Gets a list of all the trophies of a trophylist/event
java.util.concurrent.Future<APIResponse<java.util.List<Trophy>>>	getTrophiesOfListAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String trophylistId) Gets a list of all the trophies of a trophylist/event in an asynchronous way
APIResponse<Trophy>	getTrophyById(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String trophyId) Gets trophy information of a trophy from one of your trophylists/events
java.util.concurrent.Future<APIResponse<Trophy>>	getTrophyByIdAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String trophyId) Gets trophy information of a trophy from one of your trophylists/events in an asynchronous way
APIResponse<java.util.List<Trophylist>>	getTrophylistsFromLocation(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId) Gets a list of trophylists (including events) of your Location
java.util.concurrent.Future<APIResponse<java.util.List<Trophylist>>>	getTrophylistsFromLocationAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId) Gets a list of trophylists (including events) of your Location in an asynchronous way
APIResponse<User>	getUserInformation(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken) Gets the Userinformation of the user whos token this is
java.util.concurrent.Future<APIResponse<User>>	getUserInformationAsync(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken) Gets the Userinformation of the user whos token this is in an asynchronous way
APIResponse<java.lang.String>	triggerTrophyProgress(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken, com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId, java.lang.String secret) Sends a secret to fryd to trigger a trophy
java.util.concurrent.Future<APIResponse<java.lang.String>>	triggerTrophyProgressAsync(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken, com.github.scribejava.core.model.OAuth2AccessToken appAccessToken, java.lang.String locationId, java.lang.String secret) Sends a secret to fryd to trigger a trophy in an asynchronous way

Methods inherited from class com.fryd.sdk.service.AbstractFrydAPIService

createRequest, handleRequest, handleRequestAsync, handleRequestInternal, transformTrophiesResponse, transformTrophylistResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

FrydAPIService

public FrydAPIService(com.github.scribejava.core.oauth.OAuth20Service oauthService,
                      java.lang.String baseAPIUrl)

Method Detail

getFrydSpotById

public APIResponse<Location> getFrydSpotById(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                             java.lang.String locationId)
                                      throws java.lang.InterruptedException,
                                             java.util.concurrent.ExecutionException,
                                             java.io.IOException

Gets the Location Information (also called fryd Spot Information) that is part of your Account

Specified by:

getFrydSpotById in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

locationId - The id of the location/fryd Spot you own

Returns:

The location you have asked for

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getFrydSpotByIdAsync

public java.util.concurrent.Future<APIResponse<Location>> getFrydSpotByIdAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                               java.lang.String locationId)

Gets Location Information (also called fryd Spot Information) that is part of your Account in an asynchronous way

Specified by:

getFrydSpotByIdAsync in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

locationId - The id of the location/fryd Spot you own

Returns:

The location you have asked for

getTrophylistsFromLocation

public APIResponse<java.util.List<Trophylist>> getTrophylistsFromLocation(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                          java.lang.String locationId)
                                                                   throws java.lang.InterruptedException,
                                                                          java.util.concurrent.ExecutionException,
                                                                          java.io.IOException

Gets a list of trophylists (including events) of your Location

Specified by:

getTrophylistsFromLocation in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

locationId - The id of the location/fryd Spot you own

Returns:

A list of trophylists

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTrophylistsFromLocationAsync

public java.util.concurrent.Future<APIResponse<java.util.List<Trophylist>>> getTrophylistsFromLocationAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                                                            java.lang.String locationId)

Gets a list of trophylists (including events) of your Location in an asynchronous way

Specified by:

getTrophylistsFromLocationAsync in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

locationId - The id of the location/fryd Spot you own

Returns:

A list of trophylists

getTrophiesOfList

public APIResponse<java.util.List<Trophy>> getTrophiesOfList(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                             java.lang.String trophylistId)
                                                      throws java.lang.InterruptedException,
                                                             java.util.concurrent.ExecutionException,
                                                             java.io.IOException

Gets a list of all the trophies of a trophylist/event

Specified by:

getTrophiesOfList in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

trophylistId - An id of a trophylist/event of your location

Returns:

A list of trophies part of a trophylist

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTrophiesOfListAsync

public java.util.concurrent.Future<APIResponse<java.util.List<Trophy>>> getTrophiesOfListAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                                               java.lang.String trophylistId)

Gets a list of all the trophies of a trophylist/event in an asynchronous way

Specified by:

getTrophiesOfListAsync in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

trophylistId - An id of a trophylist/event of your location

Returns:

A list of trophies part of a trophylist

getTrophyById

public APIResponse<Trophy> getTrophyById(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                         java.lang.String trophyId)
                                  throws java.lang.InterruptedException,
                                         java.util.concurrent.ExecutionException,
                                         java.io.IOException

Gets trophy information of a trophy from one of your trophylists/events

Specified by:

getTrophyById in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

trophyId - An id of a trophy of one of your trophylists/events

Returns:

A trophy

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTrophyByIdAsync

public java.util.concurrent.Future<APIResponse<Trophy>> getTrophyByIdAsync(com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                           java.lang.String trophyId)

Gets trophy information of a trophy from one of your trophylists/events in an asynchronous way

Specified by:

getTrophyByIdAsync in class AbstractFrydAPIService

Parameters:

appAccessToken - A Token with the scope "AppInfo"

trophyId - An id of a trophy of one of your trophylists/events

Returns:

A trophy

getUserInformation

public APIResponse<User> getUserInformation(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken)
                                     throws java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException,
                                            java.io.IOException

Gets the Userinformation of the user whos token this is

Specified by:

getUserInformation in class AbstractFrydAPIService

Parameters:

userAccessToken - A Token with the scope "UserInfo"

Returns:

A user

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getUserInformationAsync

public java.util.concurrent.Future<APIResponse<User>> getUserInformationAsync(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken)

Gets the Userinformation of the user whos token this is in an asynchronous way

Specified by:

getUserInformationAsync in class AbstractFrydAPIService

Parameters:

userAccessToken - A Token with the scope "UserInfo"

Returns:

A user

triggerTrophyProgress

public APIResponse<java.lang.String> triggerTrophyProgress(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken,
                                                           com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                           java.lang.String locationId,
                                                           java.lang.String secret)
                                                    throws java.lang.InterruptedException,
                                                           java.util.concurrent.ExecutionException,
                                                           java.io.IOException

Sends a secret to fryd to trigger a trophy

Specified by:

triggerTrophyProgress in class AbstractFrydAPIService

Parameters:

userAccessToken - A Token with the scope "UserInfo" of the user who achieved the trophy

appAccessToken - A Token with the scope "AppInfo" of your location

locationId - The id of the location/fryd Spot you own

secret - The secret of the trophy to be achieved

Returns:

Just a response with a message or error (hopefully not)

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

triggerTrophyProgressAsync

public java.util.concurrent.Future<APIResponse<java.lang.String>> triggerTrophyProgressAsync(com.github.scribejava.core.model.OAuth2AccessToken userAccessToken,
                                                                                             com.github.scribejava.core.model.OAuth2AccessToken appAccessToken,
                                                                                             java.lang.String locationId,
                                                                                             java.lang.String secret)

Sends a secret to fryd to trigger a trophy in an asynchronous way

Specified by:

triggerTrophyProgressAsync in class AbstractFrydAPIService

Parameters:

userAccessToken - A Token with the scope "UserInfo" of the user who achieved the trophy

appAccessToken - A Token with the scope "AppInfo" of your location

locationId - The id of the location/fryd Spot you own

secret - The secret of the trophy to be achieved

Returns:

Just a response with a message or error (hopefully not)