Downloads data from the Gateway to a device running a Session.

When calling from the Gateway scope, the call must include a sessionId. 


This function interacts with mobile apps directly to ensure that download requests can be saved to the local device. Requires version 1.0.2 of the Ignition Perspective App.

This function accepts keyword arguments.

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 in UTF-8 encoding.

String contentType - Value for the "Content-Type" header, for 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. 

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

  • Returns

Nothing

  • Scope

Gateway


This function accepts keyword arguments.

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 in UTF-8 encoding.

String contentType - Value for the "Content-Type" header, for 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

Nothing

  • Scope

Perspective Session



# 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)

system perspective download, perspective.download