FileKind Property
The kind of file.
Syntax
backblazeb2.getFileKind(index, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getFileKind([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setFileKind([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
The kind of file.
This property reflects the file's kind. Possible values are:
folder | A "folder" (only applicable when listing files with a Delimiter). |
hide | A hide marker file version created by HideFile. |
start | A multipart file upload that has not been completed or abandoned yet. |
upload | An file that has been uploaded (either directly, or via a multipart upload). |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.
This property is read-only and not available at design time.
Data Type
String