Uses of Class
com.scvngr.levelup.core.annotation.LevelUpApi

Packages that use LevelUpApi

Package	Description
com.scvngr.levelup.beacon
com.scvngr.levelup.beacon.receiver
com.scvngr.levelup.beacon.service
com.scvngr.levelup.beacon.storage
com.scvngr.levelup.beacon.util
com.scvngr.levelup.bluetooth
com.scvngr.levelup.core
com.scvngr.levelup.core.model
com.scvngr.levelup.core.model.campaign
com.scvngr.levelup.core.model.factory.json
com.scvngr.levelup.core.model.paymentmethod
com.scvngr.levelup.core.model.qr
com.scvngr.levelup.core.model.tip
com.scvngr.levelup.core.net
com.scvngr.levelup.core.net.error
com.scvngr.levelup.core.net.request.factory
com.scvngr.levelup.core.service
com.scvngr.levelup.core.storage
com.scvngr.levelup.core.ui.view
com.scvngr.levelup.core.util
com.scvngr.levelup.core.util.bundle

Uses of LevelUpApi in com.scvngr.levelup.beacon

Classes in com.scvngr.levelup.beacon with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	BeaconIntents Intent constants for the LevelUp Beacon library.
interface	BeaconScanListener Listener interface to receive events when beacons are scanned.
interface	BeaconScanner Common interface to isolate beacon discovery implementation details that depend on the device's API level.
class	BeaconScannerFactory Factory for producing BeaconScanners.

Uses of LevelUpApi in com.scvngr.levelup.beacon.receiver

Classes in com.scvngr.levelup.beacon.receiver with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AppInitializeReceiver Receiver that handles CoreIntents.ACTION_APP_INITIALIZE.
class	BatteryReceiver Receiver that handles Intent.ACTION_BATTERY_LOW and Intent.ACTION_BATTERY_OKAY.
class	BluetoothReceiver Receiver that handles BluetoothAdapter.ACTION_STATE_CHANGED.
class	BootReceiver Receiver that handles Intent.ACTION_BOOT_COMPLETED.

Uses of LevelUpApi in com.scvngr.levelup.beacon.service

Classes in com.scvngr.levelup.beacon.service with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	BatteryService Service that handles battery state events.
class	BeaconScanService Service that scans for LevelUp beacons which are identified by BeaconScanService.LEVELUP_BEACON_UUID.

Uses of LevelUpApi in com.scvngr.levelup.beacon.storage

Classes in com.scvngr.levelup.beacon.storage with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	BeaconPreferenceUtil This class is a place to keep preference keys for the beacon library.

Uses of LevelUpApi in com.scvngr.levelup.beacon.util

Classes in com.scvngr.levelup.beacon.util with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	UuidUtil Utility class to work with UUIDs.

Uses of LevelUpApi in com.scvngr.levelup.bluetooth

Classes in com.scvngr.levelup.bluetooth with annotations of type LevelUpApi

Modifier and Type	Interface and Description
interface	BluetoothAdapterContainer Container for BluetoothAdapter.
interface	BluetoothLeScannerContainer Container for BluetoothLeScanner.
interface	BluetoothManagerContainer Container for BluetoothManager.
class	BluetoothManagerContainerFactory Factory for producing BluetoothManagerContainers.

Uses of LevelUpApi in com.scvngr.levelup.core

Classes in com.scvngr.levelup.core with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	CoreIntents Intent constants for the LevelUp Core library.

Uses of LevelUpApi in com.scvngr.levelup.core.model

Classes in com.scvngr.levelup.core.model with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AccessToken Represents the LevelUp access token.
class	App A connected app.
class	AppConstants Represents the App Constants.
class	Campaign Represents a campaign (which can be claimed for credit) on the server.
class	CarrierAccount Model representing a carrier account to register with carrier billing.
class	CategoriesList An immutable list of categories.
class	Category A location category.
class	CauseAffiliation Represents a cause affiliation the server.
class	Claim Represents a claim of a Campaign on the server.
class	CreditCard Model representing a Credit Card.
class	CreditCardsList Parcelable list of CreditCards.
class	Error Represents an error from the server.
class	Feedback Represents a feedback for an Order which a user can submit.
class	GiftCardValueOrder A gift card order.
class	Interstitial Model representing a receipt interstitial.
static class	Interstitial.ClaimAction Represents an interstitial that can be claimed by the user.
static class	Interstitial.FeedbackAction Represents an interstitial that requests feedback from the user.
static interface	Interstitial.InterstitialAction Interface for the different types of actions.
static class	Interstitial.ShareAction Represents an interstitial that can be shared by the user.
static class	Interstitial.UrlAction Represents an interstitial that contains a URL that can be visited by the user.
class	Location Representing a location of a merchant (which can have multiple) on the server.
class	LocationCredit Represents a credit of a Location on the server.
class	LocationList An immutable ArrayList of Locations.
class	Loyalty Represents a Loyalty progression at a merchant for a user on the server.
class	MonetaryValue Represents some amount of money on the server.
class	Order Represents an order.
class	OrdersList Parcelable list of Orders.
class	PaymentOptionsSummary Details around the options available for payment method preference.
class	PaymentPreference User's selected mode of payment preference.
class	PaymentToken Represents a user's payment token.
class	Permission A single permission of a PermissionsRequest.
class	PermissionsRequest A request for a set of permissions, made by an App on behalf of the user.
class	Registration Model representing a registration.
class	Scan Model for representing a Scan.
class	Ticket A support ticket.
class	User Represents the user.
class	UserWithAccessToken Response object when creating a user.
class	WebLink Represents external link information about a Location.
class	WebLinkList An immutable ArrayList of WebLinks.

Constructors in com.scvngr.levelup.core.model with annotations of type LevelUpApi

Constructor and Description
AccessToken(String accessToken) Public representation of an AccessToken.
AccessToken(String accessToken, Long userId) Deprecated. Use AccessToken.AccessToken(String, Long, Long) instead.
AccessToken(String accessToken, Long merchantId, Long userId)

Uses of LevelUpApi in com.scvngr.levelup.core.model.campaign

Classes in com.scvngr.levelup.core.model.campaign with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	CampaignMetadata Basic information around a specific campaign.
class	CampaignRepresentationBasicV1 Basic information about a campaign.

Uses of LevelUpApi in com.scvngr.levelup.core.model.factory.json

Classes in com.scvngr.levelup.core.model.factory.json with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AbstractJsonModelFactory<T> Superclass for JSON parsers that create model objects using a factory design pattern.
class	AccessTokenJsonFactory Factory for creating AccessTokens from JSON.
class	AppConstantsJsonFactory JSON factory to inflate the AppConstants.
class	AppJsonFactory JSON factory to inflate an App.
class	CampaignJsonFactory Factory for creating Campaigns from JSON.
class	CarrierAccountJsonFactory Factory for creating CarrierAccounts from JSON and serialize to JSON.
class	CategoryJsonFactory JSON factory for Category.
class	CauseAffiliationJsonFactory Factory for creating CreditCards from JSON.
class	ClaimJsonFactory Factory for parsing Claims from JSON.
class	CreditCardJsonFactory Factory for creating CreditCards from JSON.
class	ErrorJsonFactory Class that creates Errors from JSON.
class	GiftCardOrderJsonFactory A JSON factory to create GiftCardValueOrders.
class	GsonModelFactory<T> Loads an LevelUp model from JSON using Gson.
class	InterstitialJsonFactory Factory for parsing Interstitials from JSON.
class	LocationJsonFactory Factory for creating Locations from JSON (v14).
class	LoyaltyJsonFactory Factory for creating Loyaltys from JSON.
class	OrderJsonFactory Factory for creating Orders from JSON.
class	PaymentOptionsSummaryJsonFactory Factory for creating PaymentOptionsSummary from JSON data.
class	PaymentPreferenceJsonFactory Factory for creating PaymentPreference from JSON data.
class	PaymentTokenJsonFactory Factory for creating PaymentTokens from JSON.
class	PermissionsRequestJsonFactory Factory for loading a PermissionsRequest from JSON.
class	RegistrationJsonFactory Factory for parsing Registrations from JSON.
class	TicketJsonFactory A JSON factory to create a support Ticket.
class	UserJsonFactory Factory for creating Users from JSON.
class	UserWithAccessTokenJsonFactory Factory for creating UserWithAccessToken from JSON objects.
class	WebLinkJsonFactory Factory for creating WebLinks from JSON.

Uses of LevelUpApi in com.scvngr.levelup.core.model.paymentmethod

Classes in com.scvngr.levelup.core.model.paymentmethod with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AbstractPaymentMethod An abstract class representing a payment method.
class	ApplePayCardPaymentMethod Represents an Apple Pay card.
static class	ApplePayCardPaymentMethod.Metadata Metadata for ApplePayCardPaymentMethod.
class	CarrierAccountPaymentMethod Represents a carrier account payment method for users who pay with their carrier bill.
static class	CarrierAccountPaymentMethod.Metadata Metadata for CarrierAccountPaymentMethod.
class	CreditCardPaymentMethod Represents a credit card.
static class	CreditCardPaymentMethod.Metadata Metadata for CreditCardPaymentMethod.
class	DebitCardPaymentMethod Represents a debit card.
static class	DebitCardPaymentMethod.Metadata Metadata for DebitCardPaymentMethod.

Uses of LevelUpApi in com.scvngr.levelup.core.model.qr

Classes in com.scvngr.levelup.core.model.qr with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	CodeVersionUtils Helper class to provide utilities for checking the version of QR code and its sub-codes.
class	LevelUpCode Class to represent a QR code.
class	PaymentPreferences Class to encompass the PaymentPreferences at the end of QR codes.
class	PaymentPreferencesV3 This class may be used to encode and parse version 3 payment preferences.
class	PaymentTokenV2 Class to encompass the logic to encode V2 payment tokens combined with PaymentPreferencesV3 data.

Uses of LevelUpApi in com.scvngr.levelup.core.model.tip

Classes in com.scvngr.levelup.core.model.tip with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	PercentageTip Tip as a percentage of the purchase amount.
class	Tip<T extends Tip<T>> Represents a tip as a percentage or as US cents for purchases.
class	USCentTip Tip as an amount of US cents.

Uses of LevelUpApi in com.scvngr.levelup.core.net

Classes in com.scvngr.levelup.core.net with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AbstractRequest Object which represents an HTTP request.
class	AbstractResponse<T> Object which represents an HTTP response.
interface	AccessTokenRetriever Interface for a class that can be used to retrieve the currently logged in User's AccessToken.
class	BufferedResponse An AbstractResponse that uses a buffered interface where the response data is buffered in memory.
class	HttpMethod Enum for HTTP method types.
class	JSONArrayRequestBody A JSONArray request body.
class	JsonElementRequestBody A request body with a JsonElement.
class	JSONObjectRequestBody A JSONObject request body.
class	LevelUpConnection Class for interacting with the LevelUp web service API.
class	LevelUpRequest Class representing a request to the LevelUp web service using the API v14 and above standards.
class	LevelUpResponse Class to encompass a response from the LevelUp Web Service.
class	LevelUpStatus Enum for translating generic network responses (and exceptions) into more broad categories for use within client apps.
class	NetworkConnection Utility class for performing network operations.
interface	RequestBody Body content of a request.
class	RequestUtils Class with methods to help with creating requests.
class	StreamingResponse An AbstractResponse that uses a streaming interface where the response data is read from a stream.
class	StringRequestBody A simple RequestBody that stores the body as a String.

Uses of LevelUpApi in com.scvngr.levelup.core.net.error

Classes in com.scvngr.levelup.core.net.error with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	ErrorCode Error codes that may be returned by the LevelUp web service.
class	ErrorObject Error objects that may be returned by the web service.

Uses of LevelUpApi in com.scvngr.levelup.core.net.request.factory

Classes in com.scvngr.levelup.core.net.request.factory with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AbstractPagingRequestFactory A request factory that can page through requests.
class	AbstractRequestFactory Base class for all AbstractRequest building classes.
class	AccessTokenRequestFactory Class to build requests to interact with the endpoints that deal with AccessTokens.
class	AppConstantsRequestFactory Class to build requests to interact with the endpoints that deal with AppConstants.
class	AppLocationListRequestFactory A list of locations for a specific application ID.
class	BeaconCheckInRequestFactory Request factory to notify the LevelUp web service when an app discovers a LevelUp beacon.
class	CampaignRequestFactory Builds requests that interact with the Campaigns endpoint.
class	CarrierAccountsRequestFactory Factory to build requests that registers carrier billing sources.
class	CategoryRequestFactory Request a list of Categorys from the server.
class	ClaimRequestFactory Builds requests to claim Campaigns.
class	CreditCardRequestFactory AbstractRequest builder for requests to the Credit Cards endpoint.
class	FeedbackRequestFactory Class to build requests to interact with the feedback endpoint.
class	GcmDeviceRequestFactory Request builder for requests to the GCM Devices endpoint on the LevelUp web service.
class	GiftCardOrderRequestFactory Factory for gift card order requests.
class	InterstitialRequestFactory Request factory for dealing with Interstitials.
class	LocationCampaignsRequestFactory Factory for creating AbstractRequests for interacting with location campaigns data on the web service.
class	LocationCreditRequestFactory Class to build requests to interact with the endpoint that deals with getting credit at a specified location.
class	LocationListRequestFactory A summarized list of all LevelUp locations.
class	LocationRequestFactory Factory to build requests to interact with the Location related web service endpoints.
class	LoyaltyRequestFactory Factory for creating AbstractRequests for interacting with Loyalty on the web service.
class	MerchantCampaignsRequestFactory Factory for creating AbstractRequests for interacting with merchant campaign data on the web service.
class	OrderRequestFactory Class to build requests to interact with the order endpoint.
class	PaymentMethodRequestFactory Builds requests related to the user's payment method.
class	PaymentPreferenceRequestFactory Builds requests that interact with the payment request endpoints.
class	PaymentTokenRequestFactory Factory for creating AbstractRequest's to interact with PaymentTokens on the web service.
class	RegistrationRequestFactory Request factory for fetching a Registration from the web service.
class	TicketRequestFactory Class to build requests to interact with the endpoint that deals with support tickets.
class	UserRequestFactory Class to build requests to interact with the endpoints that deal with Users.
static class	UserRequestFactory.UserInfoRequestBuilder Builder to create a request that updates the User's information.
class	WebLinkRequestFactory Factory to build requests to interact with the WebLink related web service end points.
class	WebLinkTypeRequestFactory Factory to build requests to retrieve images for WebLinks.

Methods in com.scvngr.levelup.core.net.request.factory with annotations of type LevelUpApi

Modifier and Type	Method and Description
AbstractRequest	UserRequestFactory.UserInfoRequestBuilder.build() Builds the request which updates the User's information.
AbstractRequest	ClaimRequestFactory.buildClaimCampaignRequest(String code) Build a request to claim a generic campaign by its cohort code.
AbstractRequest	ClaimRequestFactory.buildClaimLegacyLoyaltyRequest(int loyaltyCampaignId, String loyaltyId) Build a request to claim a "Legacy Loyalty" campaign.
AbstractRequest	CreditCardRequestFactory.buildCreateCardRequest(String cardNumber, String cvv, String expirationMonth, String expirationYear, String postalCode) Builds a request to the server which will add a credit card for the current user.
AbstractRequest	CreditCardRequestFactory.buildDeleteCardRequest(CreditCard card) Builds a request to delete a credit card.
AbstractRequest	AccessTokenRequestFactory.buildDowngradeRequest(Collection<Permission> permissions) Build a request for a downgraded scoped access token.
AbstractRequest	AccessTokenRequestFactory.buildDowngradeRequest(Permission... permissions) Build a request for a downgraded scoped access token.
AbstractRequest	AccessTokenRequestFactory.buildDowngradeRequest(String... permissionKeyNames) Build a request for a downgraded scoped access token.
AbstractRequest	UserRequestFactory.buildFacebookConnectRequest(String facebookAccessToken) Builds a request to connect a user to Facebook.
AbstractRequest	UserRequestFactory.buildFacebookDisconnectRequest() Builds a request to disconnect a user from Facebook.
AbstractRequest	AccessTokenRequestFactory.buildFacebookLoginRequest(String facebookAccessToken) Build a request to perform a login with Facebook.
AbstractRequest	UserRequestFactory.buildFacebookRegisterRequest(String facebookAccessToken) Build a request to register a new User via a facebook access token.
AbstractRequest	FeedbackRequestFactory.buildFeedbackRequest(String orderUuid, Feedback feedback) Builds a request for posting feedback for a given order.
AbstractRequest	UserRequestFactory.buildForgotPasswordRequest(String email) Get a request that will allow the user to reset their password.
AbstractRequest	AppConstantsRequestFactory.buildGetAppConstantsRequest(String apiKey, int id) Build a request to retrieve the App Constants information.
AbstractRequest	CampaignRequestFactory.buildGetCampaignDetailsByRepresentationType(CampaignMetadata metadata, CampaignRepresentationType representationType)
AbstractRequest	CampaignRequestFactory.buildGetCampaignIcon(long campaignWebServiceId, CampaignRequestFactory.IconSize iconSize)
AbstractRequest	CreditCardRequestFactory.buildGetCardsRequest() Builds a request to get the credit cards for a user.
AbstractRequest	LocationCampaignsRequestFactory.buildGetLocationCampaignsRequest(long locationWebServiceId)
AbstractRequest	LoyaltyRequestFactory.buildGetLoyaltyForMerchantRequest(long merchantWebServiceId)
AbstractRequest	MerchantCampaignsRequestFactory.buildGetMerchantCampaignsRequest(long merchantWebServiceId)
AbstractRequest	PaymentTokenRequestFactory.buildGetPaymentTokenRequest()
AbstractRequest	UserRequestFactory.buildGetUserInfoRequest() Build a request to retrieve the User information.
AbstractRequest	InterstitialRequestFactory.buildInterstitialForOrderRequest(String orderUuid) Build a request to get the Interstitial for the order passed.
AbstractRequest	InterstitialRequestFactory.buildInterstitialImageRequest(Interstitial interstitial) Build a request to get the image for the Interstitial passed.
AbstractRequest	LocationCreditRequestFactory.buildLocationCreditRequest(Location location) Build a request to request credit at a given location.
AbstractRequest	AccessTokenRequestFactory.buildLoginRequest(String email, String password) Build a request to perform a login with email/password.
AbstractRequest	CreditCardRequestFactory.buildPromoteCardRequest(CreditCard card) Builds a request to promote (set as default) a credit card.
AbstractRequest	UserRequestFactory.buildRegisterRequest(String firstName, String lastName, String email, List<String> permissions) Build a request to create a new user.
AbstractRequest	UserRequestFactory.buildRegisterRequest(String firstName, String lastName, String email, String password, Location location) Build a request to create a new user.
AbstractRequest	RegistrationRequestFactory.buildRegistrationRequest(String email) Build a request to get the Registration for the email passed.
AbstractRequest	TicketRequestFactory.buildSupportRequest(String messageBody, String category) Build a request to submit a support request for the current user.
AbstractRequest	OrderRequestFactory.newGetAppOrdersRequest(int page) Builds a request to get a list of orders for the current user.
AbstractRequest	OrderRequestFactory.newGetAppOrdersRequest(long appId, int page) Deprecated.
AbstractRequest	OrderRequestFactory.newGetOrderRequest(String orderUuid) Builds a request to get a single order.

Uses of LevelUpApi in com.scvngr.levelup.core.service

Classes in com.scvngr.levelup.core.service with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AbstractNetworkRequestService Abstract base class to be used for services that do network requests in the background and may or may not want to send results back to the clients that triggered the request.
class	SilentNetworkRequestService Intent Service to send requests in the background that we do not care to read the response of.

Uses of LevelUpApi in com.scvngr.levelup.core.storage

Classes in com.scvngr.levelup.core.storage with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	CorePreferenceUtil This class is a place to keep preference keys for the core library.
class	SharedPreferencesUtil Utility class to help simplify interaction with SharedPreferences.

Uses of LevelUpApi in com.scvngr.levelup.core.ui.view

Classes in com.scvngr.levelup.core.ui.view with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	AsyncTaskCodeLoader Loads and caches LevelUpQrCodeGenerator.LevelUpQrCodeImages using AsyncTasks.
class	LevelUpCodeLoader Load a LevelUp payment QR code.
class	LevelUpOAuth2View Customized WebView which makes requests to LevelUp's OAuth2 endpoints.

Uses of LevelUpApi in com.scvngr.levelup.core.util

Classes in com.scvngr.levelup.core.util with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	BuildUtil This is a utility class to determine information about the build of the app.
class	CoreLibConstants This is a utility class containing global constants for the app.
class	CryptographicHashUtil This is a utility class to generate cryptographic hashes.
class	DeviceIdentifier This is a utility class to uniquely determine the identity of the device.
class	DeviceUtil Utility class for methods pertaining to the user's device.
class	DistanceUtil Utilities to convert distances to other units.
class	EnvironmentUtil This is a utility class to determine information about the environment the app is running under.
class	ExceptionUtil Utilities for creating common Exceptions.
class	IsoDateUtils Helper utility class to handle date operations.
class	Key Utilities for creating common key constants.
class	LinkHeaderParser A regular expression -based parser implementing RFC5988.
class	LogManager This is a utility class to wrap the Android Log class.
class	NullUtils Utilities to help use NonNull and Nullable annotations.
class	PermissionUtil This is a utility class to check permissions available to the current app.
class	PreconditionUtil This is a utility class to enforce preconditions.
class	SandboxUtils Utility used to determine whether to grab production or sandbox resources.
class	StrictModeUtil This is a utility class to use StrictMode without worrying about backwards compatibility.
class	ThreadUtil This is a utility class for thread management on Android.

Uses of LevelUpApi in com.scvngr.levelup.core.util.bundle

Classes in com.scvngr.levelup.core.util.bundle with annotations of type LevelUpApi

Modifier and Type	Class and Description
class	BundleScrubber Helper class to scrub Bundles of invalid extras.