Package com.inductiveautomation.perspective.gateway.api

Interface FetchableCache

All Known Implementing Classes:

FetchableCacheImpl

public interface FetchableCache

The FetchableCache is a place for perspective component model delegates to place downloadable data (named "fetch"-able after the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API>Fetch API) for their front-end counterparts to fetch in the near future.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FetchableCache.Fetchable

Method Summary

Modifier and Type	Method	Description
default String	addFetchable(Session session, com.inductiveautomation.ignition.common.gson.JsonElement json)
String	addFetchable(Session session, FetchableCache.Fetchable fetchable)	Place some fetchable data into the cache.
default String	addFetchable(Session session, String contentType, String payload)

Method Details

addFetchable

String addFetchable(Session session,
 FetchableCache.Fetchable fetchable)

Place some fetchable data into the cache.

Parameters:

session - The session that this data belongs to. Only requests from this session will be able to use the resulting URL.

fetchable - The handler that will handle the GET request.

Returns:

A URL string to be used by a front-end request to retrieve the fetchable data. This URL will expire in 5 minutes or immediately after access, whichever is first. The URL will be relative to the root, e.g. /data/perspective/myProject/uuid

addFetchable

default String addFetchable(Session session,
 com.inductiveautomation.ignition.common.gson.JsonElement json)

addFetchable

default String addFetchable(Session session,
 String contentType,
 String payload)