CameraKit/com.snap.camerakit.lenses/LensesComponent/RemoteApiService

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.

Since

1.13.0

Types

Call

sealed class Call

Represents all the possible outcomes when RemoteApiService processes a Request.

Companion

object 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

object Noop : LensesComponent.RemoteApiService

Convenience implementation of RemoteApiService which ignores all requests.

Request

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

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

Response

class Response(val request: LensesComponent.RemoteApiService.Request, val status: LensesComponent.RemoteApiService.Response.Status, val metadata: Map<String, String>, val body: ByteArray)

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

Functions

abstract override fun close()

Closes all resources allocated for this RemoteApiService. Overridden to indicate that calling close will not throw.

process

abstract fun process(request: LensesComponent.RemoteApiService.Request, onResponse: Consumer<LensesComponent.RemoteApiService.Response>): LensesComponent.RemoteApiService.Call

Attempts to process the request with one or multiple Responses sent back to the provided onResponse. The returned Call indicates how this RemoteApiService handled the request so that callers can act accordingly:

Inheritors

Noop