com.scvngr.levelup.core.net.request.factory

Class BeaconCheckInRequestFactory

java.lang.Object

com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

com.scvngr.levelup.core.net.request.factory.BeaconCheckInRequestFactory

@ThreadSafe
 @LevelUpApi(contract=PUBLIC)
public final class BeaconCheckInRequestFactory
extends AbstractRequestFactory

Request factory to notify the LevelUp web service when an app discovers a LevelUp beacon. If your app registers GCM devices with LevelUp using GcmDeviceRequestFactory, then users may receive a GCM notification shortly after the beacon check-in, alerting them that they can pay with your app at the nearby location. Beacon messages can be configured within the LevelUp Dashboard. LevelUp beacons have the UUID 56DB0365-A001-4062-9E4D-499D3B8ECCF3.

See Also:

Bluetooth Low Energy, Android 5.0 Bluetooth LE APIs

Constructor Summary

Constructors

Constructor and Description
BeaconCheckInRequestFactory(Context context, AccessTokenRetriever retriever)

Method Summary

Modifier and Type	Method and Description
AbstractRequest	buildBeaconCheckInRequest(String majorId, String minorId) Build a beacon check in request.

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

getAccessTokenRetriever, getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BeaconCheckInRequestFactory

public BeaconCheckInRequestFactory(Context context,
                                   AccessTokenRetriever retriever)

Parameters:

context - the Application context.

retriever - the AccessTokenRetriever to use to retrieve the AccessToken.

Method Detail

buildBeaconCheckInRequest

public AbstractRequest buildBeaconCheckInRequest(String majorId,
                                                 String minorId)

Build a beacon check in request. The request may be performed with or without an access token. Checking in with an access token requires the Permissions.PERMISSION_BEACON_CHECKINS permission.

Parameters:

majorId - The string value of the major value of the beacon.

minorId - The string value of the minor value of the beacon.

Returns:

an AbstractRequest to check-in when an app gets in range of a LevelUp beacon.