ripe / com.ripe.android.api / BaseAPI

BaseAPI

interface BaseAPI

This interface contains the base methods to be used by the various API classes. The contents of these class can be safely used by other related "mixins".

Properties

owner

abstract val owner: Ripe

The Ripe instance that is using the API.

Functions

getImageUrl

open fun getImageUrl(options: Map<String, Any> = HashMap()): String

Returns the url of a composition for the current configuration.

getPriceAsync

open fun getPriceAsync(options: Map<String, Any> = HashMap()): Deferred<Map<String, Any>?>

Retrieves the price for current configuration. Returns a Deferred object that will be completed asynchronously.

getUrl

open fun getUrl(): String

Helper method that retrieves the base API URL from the owner's options.

Inheritors

BrandAPI

interface BrandAPI : BaseAPI

The interface for the Brand API.

BuildAPI

interface BuildAPI : BaseAPI

The interface for the Build API.

LocaleAPI

interface LocaleAPI : BaseAPI

The interface for the Locale API.

RipeAPI

class RipeAPI : BaseAPI, BrandAPI, BuildAPI, LocaleAPI, SizeAPI

The API class to be instantiated. Implements all the API interfaces.

SizeAPI

interface SizeAPI : BaseAPI

The interface for the Size API.