Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetFileOptions

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

Hierarchy

Index

Properties

Properties

Optional app

app: undefined | 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: boolean | string

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: undefined | string

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

Optional verify

verify: undefined | false | true

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

default

false

Optional zoneFileLookupURL

zoneFileLookupURL: undefined | string

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

Generated using TypeDoc