Interface Schema$Drive

Representation of a shared drive.

Hierarchy

  • Schema$Drive

Properties

backgroundImageFile? backgroundImageLink? capabilities? colorRgb? createdTime? hidden? id? kind? name? orgUnitId? restrictions? themeId?

Properties

Optional backgroundImageFile

backgroundImageFile?: {
    id?: string;
    width?: number;
    xCoordinate?: number;
    yCoordinate?: number;
}

An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

Type declaration

  • Optional id?: string
  • Optional width?: number
  • Optional xCoordinate?: number
  • Optional yCoordinate?: number

Optional backgroundImageLink

backgroundImageLink?: string

A short-lived link to this shared drive's background image.

Optional capabilities

capabilities?: {
    canAddChildren?: boolean;
    canChangeCopyRequiresWriterPermissionRestriction?: boolean;
    canChangeDomainUsersOnlyRestriction?: boolean;
    canChangeDriveBackground?: boolean;
    canChangeDriveMembersOnlyRestriction?: boolean;
    canComment?: boolean;
    canCopy?: boolean;
    canDeleteChildren?: boolean;
    canDeleteDrive?: boolean;
    canDownload?: boolean;
    canEdit?: boolean;
    canListChildren?: boolean;
    canManageMembers?: boolean;
    canReadRevisions?: boolean;
    canRename?: boolean;
    canRenameDrive?: boolean;
    canResetDriveRestrictions?: boolean;
    canShare?: boolean;
    canTrashChildren?: boolean;
}

Capabilities the current user has on this shared drive.

Type declaration

  • Optional canAddChildren?: boolean
  • Optional canChangeCopyRequiresWriterPermissionRestriction?: boolean
  • Optional canChangeDomainUsersOnlyRestriction?: boolean
  • Optional canChangeDriveBackground?: boolean
  • Optional canChangeDriveMembersOnlyRestriction?: boolean
  • Optional canComment?: boolean
  • Optional canCopy?: boolean
  • Optional canDeleteChildren?: boolean
  • Optional canDeleteDrive?: boolean
  • Optional canDownload?: boolean
  • Optional canEdit?: boolean
  • Optional canListChildren?: boolean
  • Optional canManageMembers?: boolean
  • Optional canReadRevisions?: boolean
  • Optional canRename?: boolean
  • Optional canRenameDrive?: boolean
  • Optional canResetDriveRestrictions?: boolean
  • Optional canShare?: boolean
  • Optional canTrashChildren?: boolean

Optional colorRgb

colorRgb?: string

The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.

Optional createdTime

createdTime?: string

The time at which the shared drive was created (RFC 3339 date-time).

Optional hidden

hidden?: boolean

Whether the shared drive is hidden from default view.

Optional id

id?: string

The ID of this shared drive which is also the ID of the top level folder of this shared drive.

Optional kind

kind?: string

Identifies what kind of resource this is. Value: the fixed string "drive#drive".

Optional name

name?: string

The name of this shared drive.

Optional orgUnitId

orgUnitId?: string

The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.

Optional restrictions

restrictions?: {
    adminManagedRestrictions?: boolean;
    copyRequiresWriterPermission?: boolean;
    domainUsersOnly?: boolean;
    driveMembersOnly?: boolean;
}

A set of restrictions that apply to this shared drive or items inside this shared drive.

Type declaration

  • Optional adminManagedRestrictions?: boolean
  • Optional copyRequiresWriterPermission?: boolean
  • Optional domainUsersOnly?: boolean
  • Optional driveMembersOnly?: boolean

Optional themeId

themeId?: string

The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

Settings

Member Visibility

Theme

Generated using TypeDoc