$fn.getPresignedUrl(path,options)

Issues a signed URL to access a file manager in the WebPerformerNX execution environment. "asynchronous"

Note

• This function is available only in the Premium Execution Environment.
• As an asynchronous function, it requires an await expression at call time
• By specifying the path of a file to which access rights are to be granted, the file can be uploaded/downloaded for a specified valid time.
  • File uploads are limited to a maximum of 5 GB.
  • There is no limit to the validity time, but for security reasons, we do not recommend setting a long validity time.

Argument

Name	Type	Description
path	string	File path of the file manager issuing the signed URL Support for the following query parameter Query Parameter Description response-content-type Override Content-type in response headers If not specified, binary/octet-stream is set response-cache-control Override Cache-control in response headers
options	object	Signed URL validity time

Options Details

Property	Type	Description
expiresIn	number	Validity time of signed URL (seconds) Default is 900

Note

• Two types of wildcards can be specified in the "path" property
  • Asterisk (*): matches zero or more characters
  • Question mark (?): matches one character
• If the "path" property contains multibyte or special symbols (#$&+,/:;=?@) must be encoded.
  • If the path contains multibytes, the entire path must be encoded with the encodeURI function.
  • If the path contains special symbols, encode the part containing the special symbols individually with the encodeURIComponent function and combine the path.
• The maximum number of bytes for a character in the "path" property is 988 bytes.
• When granting access to a folder, specify a wildcard in the "path" property to grant access under the folder, such as "/folder name/*".
  • When using a signed URL issued with a wildcard, change the wildcard part to a file name.
• When including query parameters in the "path" property, ? must be escaped with a backslash.
• If the "path" property contains a response-content-type, the MIME type slash is encoded. Published signed URLs must be converted back to slashes before they can be used.
• File downloads in cache-enabled browsers may be downloaded from disk cache outside the validity time. Do not use query parameters to save the cache.

Return value

Type	Description
String	Signed URL

Sample

// Query parameter (cache:don't save, MIME type:application/pdf) specified in file path
const path = $ui.filePath.value + "\?response-cache-control=no-store&response-content-type=application/pdf";
// Issuing a signed URL with a validity time of 10 minutes
$ui.url.value = await $fn.getPresignedUrl(path, {expiresIn:600});

Note

Expiration Date of Signed URL
If the client starts downloading a large file just before the expiration time, the download will complete even if the expiration time elapses during the download.
If the TCP connection is interrupted and the client resumes the download after the expiration time has elapsed, the download will fail.

Note

Example of procedure for uploading a file using a signed URL This is an example of uploading a file by executing the curl command.

1. Issue a signed URL that gives access rights under the folder to be accessed for the “path”property.
   Eg：await $fn.getPresignedUrl(‘/My_Folder/*’, {expiresIn:600});

2. Change the wildcard portion (*) of the URL issued in step 1 to the filename to be uploaded to the file manager.
   Eg: Set the name of the file to be uploaded as sample.jpg.
   https://<domain>/<owner ID>/My_Folder/sample.jpg?Policy=・・・

3. Execute the curl command to upload the file.
   Eg: curl -X PUT —upload-file C:\temp\sample.jpg “Signed URL updated in step 2”