RemoteApiService

Provides ability to handle remote API requests that originate within lenses. Lifecycle of a RemoteApiService is scoped to a lifecycle of a single lens. To provide RemoteApiService instances, register a RemoteApiService.Factory via the Builder.remoteApiServiceFactory method.

1.13.0

Types

Call

sealed class Call

Represents all the possible outcomes when RemoteApiService processes a Request.

Companion

Provides ability to attach utility functions to the RemoteApiService interface on implementation side.

Factory

interface Factory

Creates instances of RemoteApiService scoped to a lifecycle of a single lens.

Noop

Convenience implementation of RemoteApiService which ignores all requests.

Request

class Request(id: String, apiSpecId: String, endpointId: String, parameters: Map<String, String>, body: ByteArray)

Defines the data model for a request sent by a lens.

Response

Defines the data model for a response to a request sent by a lens.

abstract override fun close()

Closes all resources allocated for this RemoteApiService.

process

Attempts to process the request with one or multiple Responses sent back to the provided onResponse.

LensesComponent.RemoteApiService