Interface: ExpofpViewModuleMethods
Defined in: types.ts:11
Interface for the ExpoFP View Module methods. These methods are available on the native module level.
Methods
downloadPlan()
downloadPlan(
expoKey):Promise<string>
Defined in: types.ts:40
Downloads a plan for the given Expo key.
For debug purposes the Expo key can be replaced with a direct link to a <expoKey>_<version>.zip file, e.g. https://yourdomain.com/yourpath/demo_42.zip.
Parameters
expoKey
string
The Expo key of the plan to download, or a direct link to its .zip.
Returns
Promise<string>
A promise that resolves with the result of the download operation.
getDownloadedPlansInfo()
getDownloadedPlansInfo(
expoKey):Promise<ExpoFpDownloadedPlanInfo[]>
Defined in: types.ts:61
Gets information about downloaded plans.
Parameters
expoKey
Optional Expo key to filter the results.
string | null
Returns
Promise<ExpoFpDownloadedPlanInfo[]>
A promise that resolves with an array of downloaded plan info.
getPreloadedPlansInfo()
getPreloadedPlansInfo():
Promise<ExpoFpPreloadedPlanInfo[]>
Defined in: types.ts:22
Gets information about all preloaded plans.
Returns
Promise<ExpoFpPreloadedPlanInfo[]>
A promise that resolves with an array of preloaded plan info.
preloadPlan()
preloadPlan(
settings):Promise<string>
Defined in: types.ts:17
Preloads a plan with the given settings.
Parameters
settings
Partial<ExpofpViewSettings>
The settings to use for preloading the plan.
Returns
Promise<string>
A promise that resolves with the result of the preload operation.
removeAllDownloadedPlans()
removeAllDownloadedPlans():
void
Defined in: types.ts:77
Removes all downloaded plans.
Returns
void
removeAllPreloadedPlans()
removeAllPreloadedPlans():
void
Defined in: types.ts:31
Removes all preloaded plans.
Returns
void
removeDownloadedPlan()
removeDownloadedPlan(
downloadedPlanInfo):void
Defined in: types.ts:73
Removes a specific downloaded plan.
Parameters
downloadedPlanInfo
The info of the downloaded plan to remove.
Returns
void
removeOldVersionsOfDownloadedPlans()
removeOldVersionsOfDownloadedPlans(
expoKey):void
Defined in: types.ts:68
Removes old versions of downloaded plans.
Parameters
expoKey
Optional Expo key to filter the removal.
string | null
Returns
void
removePreloadedPlan()
removePreloadedPlan(
preloadedId):void
Defined in: types.ts:27
Removes a specific preloaded plan.
Parameters
preloadedId
string
The ID of the preloaded plan to remove.
Returns
void
unzipPlan()
unzipPlan(
resourceName):Promise<string>
Defined in: types.ts:55
Unzips (imports) a plan from a local .zip.
Accepts either:
- the name of a bundled resource (iOS: app bundle, Android: assets), e.g.
demo_42; or - a path to a user-picked
.zip: an absolute file path, or afile:URI. The.zipmust be named<expoKey>_<version>.zip(e.g.demo_42.zip) — the expo key and version are derived from the file name.
Parameters
resourceName
string
The bundled resource name (without extension) or the file path / URI of the .zip to import. On Android, only file: URIs / absolute paths are accepted — convert a content:// URI first (e.g. via keepLocalCopy from @react-native-documents/picker).
Returns
Promise<string>
A promise that resolves with the result of the unzip operation.