Class: FileResult

FileResult

The FileResult class is used to store the file information.


new FileResult( [share] [, directory] [, name])

Creates a new FileResult object.

Parameters:
Name Type Argument Description
share string <optional>

The share name.

directory string <optional>

The directory name.

name string <optional>

The file name.

Properties:
Name Type Description
share string

The share name.

directory string

The directory name.

name string

The file name.

metadata object

The metadata key/value pair.

etag string

The etag.

lastModified string

The date/time that the file was last modified.

requestId string

The request id.

acceptRanges string

The accept ranges.

serverEncrypted string

If the file data and application metadata are completely encrypted using the specified algorithm. true/false.

contentRange string

The content range

contentLength string

The size of the file in bytes.

contentSettings object

The content settings.

Properties
Name Type Description
contentType string

The content type.

contentEncoding string

The content encoding.

contentLanguage string

The content language.

cacheControl string

The cache control.

contentDisposition string

The content disposition.

contentMD5 string

The content MD5 hash.

copy object

The copy information.

Properties
Name Type Description
id string

The copy id.

status string

The copy status.

completionTime string

The copy completion time.

statusDescription string

The copy status description.

progress string

The copy progress.

source string

The copy source.

Source:

Methods


<static> setHeaders()

This method sets the HTTP headers and is used by all methods except setFileProperties and createFile.
Those methods will set the x-ms-* headers using setProperties.

Source:

<static> setProperties()

This method sets the x-ms-* headers and is used by setFileProperties and createFile.
All other methods will set the regular HTTP headers using setHeaders.

Source: