ConvertDocument Property

Whether to convert a document when uploading.

Syntax

 googledrive.getConvertDocument([callback])
 googledrive.setConvertDocument( convertDocument, [callback])

Default Value

FALSE

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 getConvertDocument([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 setConvertDocument([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

This property determines whether a document is converted to the corresponding Google Docs format when UploadFile is called. The default value is False.

Note: When setting this property to true it may be necessary to explicitly specify the FileFormat parameter when calling DownloadFile at a later time. Available formats are supplied through the ResourceFormats property.

Data Type

Boolean