Interface RemoteApiService

Service to handle a lens Remote API request.

interface RemoteApiService {
    apiSpecId: string;
    getRequestHandler(
        request: RemoteApiRequest,
        lens: Lens,
    ): undefined | RemoteApiRequestHandler;
}

Index

Properties

Methods

getRequestHandler

Properties

apiSpecId

apiSpecId: string

Remote API spec ID(s).

Methods

getRequestHandler

getRequestHandler(
request: RemoteApiRequest,
lens: Lens,
): undefined | RemoteApiRequestHandler
This method is called by Camera Kit when a lens triggers a Remote API request with a corresponding spec ID. If the service can handle the request, the method returns a request handler; otherwise, it returns nothing.
Parameters
- request: RemoteApiRequest
  Remote API request object.
- lens: Lens
  Lens that triggers the request.
Returns undefined | RemoteApiRequestHandler
A request handler if applicable.