ripe / com.ripe.android.api / LocaleAPI

LocaleAPI

interface LocaleAPI : BaseAPI

The interface for the Locale API.

Inherited Properties

owner

abstract val owner: Ripe

The Ripe instance that is using the API.

Functions

localeAsync

open fun localeAsync(value: String, locale: String, options: Map<String, Any>): Deferred<Map<String, Any>?>

Localizes a value to the provided locale.

localeMultipleAsync

open fun localeMultipleAsync(values: List<String>, locale: String, options: Map<String, Any>): Deferred<Map<String, Any>?>

Localizes a list of values to the provided locale.

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.