GetResourceInfo Method

Retrieves information about the specified resource.

Syntax

box.getResourceInfo([callback])

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 this 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 method retrieves information about the resource specified by ResourceId. Before calling this method set ResourceType and ResourceId. After calling this method the following properties are populated:

• ResourceCreatedBy
• ResourceCreatedDate
• ResourceDeleted
• ResourceDeletedDate
• ResourceDescription
• ResourceETag
• ResourceHash
• ResourceId
• ResourceModifiedBy
• ResourceModifiedDate
• ResourceName
• ResourceOwner
• ResourceParentId
• ResourcePurgedDate
• ResourceRevision
• ResourceSize
• ResourceSyncState (Folders Only)
• ResourceTags

If the resource has been deleted (but not permanently deleted), ResourceId and ResourceDeleted should be set before calling this method.