ripe / com.ripe.android.api / BrandAPI

BrandAPI

interface BrandAPI : BaseAPI

The interface for the Brand API.

Inherited Properties

owner

abstract val owner: Ripe

The Ripe instance that is using the API.

Functions

getConfigAsync

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

Returns the configuration information of a specific brand and model. If no model is provided then returns the information of the owner's current model. The options map accepts the following keys:

getDefaultsAsync

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

Returns the default customization of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Inherited 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

RipeAPI

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

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