Interface GetFileOptions

Used to pass options to [[UserSession.getFile]]

Hierarchy

Properties

app? decrypt? username? verify? zoneFileLookupURL?

Properties

Optional app

app?: string

The app to lookup for multi-player storage - defaults to current origin.

Default

window.location.origin Only if available in the executing environment, otherwise undefined.

Optional decrypt

decrypt?: string | boolean

Try to decrypt the data with the app private key. If a string is specified, it is used as the private key.

Default

true

Optional username

username?: string

The Blockstack ID to lookup for multi-player storage. If not specified, the currently signed in username is used.

Optional verify

verify?: boolean

Whether the content should be verified, only to be used when [[UserSession.putFile]] was set to sign = true.

Default

false

Optional zoneFileLookupURL

zoneFileLookupURL?: string

The URL to use for zonefile lookup. If falsey, this will use the blockstack.js's [[getNameInfo]] function instead.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc