bloombox / bloombox.client.services.menu

Package bloombox.client.services.menu

Retrieve menu/product catalog data, either in full, or section by section. Also exposes methods for retrieving individual product data from various perspectives.

Types

MenuClient

class MenuClient : RPCClient, ServiceClient

Menu API client. Provides access to menu/product catalog data for a particular partner and location pair. Menus can' be requested in full or section by section. By default, items marked as "invisible" are not returned - these are items considered out-of-stock or no longer carried by the partner. To retrieve all items, pass full as true.

MenuClientError

enum class MenuClientError : ClientError

Enumerates known or otherwise identifiable menu errors that might occur.

Type Aliases

MenuCallback

typealias MenuCallback = (Response) -> Unit

Callback type that provides an asynchronous response to a menu retrieval request. Accepts a response value - a null response is itself considered an error - and provides no return value.

MenuErrorCallback

typealias MenuErrorCallback = (ClientException?) -> Unit

Error case callback type that handles ServiceClientException-compliant throwables. Accepts a compliant instance of ServiceClientException and provides no return value.