SharedDriveRestrictions Property

The restrictions that apply to the shared drive.

Syntax

 googledrive.getSharedDriveRestrictions(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 getSharedDriveRestrictions([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 setSharedDriveRestrictions([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 restrictions that apply to the shared drive.

This property specifies the restrictions that apply to the shared drive. The value is a bitmask comprised of one or more of the following, OR'ed together:


Hex Value	Description
`0x0001`	Administrative privileges on the shared drive are required to modify restrictions.
`0x0002`	Readers and commenters cannot copy, print, or download files in the shared drive.
`0x0004`	Access to the shared drive, and its contents, is restricted to users in its domain.
`0x0008`	Access to items in the shared drive is restricted to its members.

The UpdateSharedDrive method can be used to change any of the shared drive's restrictions that the current user is allowed to alter (indicated by the presence of the 0x00002, 0x00004, and/or 0x00010 flags in the SharedDriveCapabilities property).

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

This property is read-only and not available at design time.

Data Type