Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Scripting_function



Panel
titleDescription

Downloads data from the gateway to a device running a session.


Panel
titleSyntax

system.perspective.download(filename, data, [contentType, sessionId, pageId])

  • Parameters

String filename - Suggested name for the downloaded file.

String data - The data to be downloaded. May be a String, a byte[], or an InputStream. Strings will be written with in "UTF-8" encoding.

String contentType - Value for the "Content-Type" header. Example: "text/plain; charset=utf-8" [optional]

String sessionId - Identifier of the Session to target. If omitted, the current Session will be used automatically. When targeting a different session, then the pageId parameter must be included in the call. [optional]

String pageId - Identifier of the Page to target. If omitted, the current Page will be used automatically. [optional]

  • Returns

None

  • Scope

Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
# Downloads the file "myFile.pdf" (located on the gateway) to the user running the current session.

filename = 'myFile.pdf'
data = system.file.readFileAsBytes('C:\\'+filename)
system.perspective.download(filename, data)




Panel
titleKeywords

system perspective download, perspective.download