Global

Members

(constant) rebuildMediaURLCachePromises :Map.<string, Promise.<(Record.<string, string>|Array.<ManifestItem>)>>

Source:
Type:
  • Map.<string, Promise.<(Record.<string, string>|Array.<ManifestItem>)>>

(constant) ResourceType :'0'|'1'

Source:
Properties:
Name Type Description
MANIFEST '0' | '1'
INSTANCE '0' | '1'
Type:
  • '0' | '1'

Methods

createMediaURL(options)

Source:
Parameters:
Name Type Description
options MediaURLOptions

escapeFileName(fileName)

Source:
Parameters:
Name Type Description
fileName string

escapeURL(url)

Source:
Parameters:
Name Type Description
url string

(async) getHostURL(options)

Source:
Parameters:
Name Type Description
options HostURLOptions

(async) getManifest(enketoId, options) → {Promise.<Survey>}

Source:
Parameters:
Name Type Description
enketoId string
options HostURLOptions
Returns:
Type
Promise.<Survey>

(async) getMediaMap(media, options)

Source:
Parameters:
Name Type Description
string
media Array.<ManifestItem> | Record.<string, string>
options HostURLOptions

(async) getSurveyInfo(enketoId, options) → {Promise.<Survey>}

Source:

A simplified version of the minimal logic performed in transformation-controller.js, for cached forms. Currently redundantly reimplemented, because:

  • transformation-controller doesn't and currently can't export it
  • this omits some logic which is performed when caching forms, but it's intended purpose is to support retrieving a manifest for an already-cached form.

In the future we can investigate whether this logic can be reused there, eliminating the redundancy.

Parameters:
Name Type Description
enketoId string
options HostURLOptions
Returns:
Type
Promise.<Survey>

matchMediaURLSegments(requestPath) → {MediaURLSegments|void}

Source:
Parameters:
Name Type Description
requestPath string
Returns:
Type
MediaURLSegments | void

(async) rebuildMediaURLCache(resourceType, resourceId, options)

Source:
Parameters:
Name Type Description
resourceType ResourceType
resourceId string
options HostURLOptions

Type Definitions

EnketoRecord

Source:
See:
Properties:
Name Type Attributes Description
enketoId string

identifier for the form the record is associated with
instanceId string

the record's primary key identifier
name string

a unique name assigned to the record by a user
xml string

the serialized representation of the record's current state
created string <optional>

when the record was created in the store
updated string <optional>

when the record was most recently updated in the store
deprecatedId string <optional>

deprecated (previous) ID of record
draft boolean <optional>

whether the record was saved either as a draft or auto-saved
files Array.<window.File> <optional>

any files attached to the record

HostURLOptions

Source:
Properties:
Name Type Attributes Description
auth string <optional>
basePath string
cookie string <optional>
mediaHash string <optional>
requestPath string

MediaURLOptions

Source:
Properties:
Name Type Description
basePath string
fileName string
resourceType string
resourceId string

MediaURLSegments

Source:
Properties:
Name Type Description
resourceType string
resourceId string
fileName string