如何用TypeScript结合Google Drive API v3设置文件权限及迁移v2代码？

Let's break down how to migrate your v2 permission code to v3 in TypeScript, especially since the type definitions and API structure have shifted a bit:

Key Differences to Note #

First, in v3, the insert method was renamed to create, and the way you pass permission data has changed. Instead of using a resource property in the method arguments, TypeScript's @types/gapi.client.drive defines the permission payload as a requestBody parameter. Additionally, the v2 value field was split into more specific fields in v3 based on the permission type.

Migration Steps & Example Code #

Your original v2 JavaScript code looked something like this:

var body = { 'value': value, 'type': type, 'role': role };
gapi.client.drive.permissions.insert({
  'fileId': fileId,
  'resource': body
});

Here's how to rewrite this for v3 in TypeScript, aligned with the official type definitions:

// Ensure you've installed @types/gapi.client.drive via npm first
import gapi from 'gapi.client';

// Define the permission payload using the typed Permission interface
const permissionPayload: gapi.client.drive.Permission = {
  // Replace 'value' with the appropriate field based on your permission type:
  emailAddress: value, // Use this for 'user' or 'group' types
  // domain: value, // Use this instead if your type is 'domain'
  type: type, // Valid values: 'user', 'group', 'domain', 'anyone'
  role: role // Valid values: 'owner', 'writer', 'reader', etc.
};

// Call the v3 create method with requestBody instead of resource
gapi.client.drive.permissions.create({
  fileId: fileId, // Required: ID of the file you're sharing
  requestBody: permissionPayload,
  // Optional parameters (add these if needed):
  sendNotificationEmail: true, // Whether to send a notification email (default: true)
  emailMessage: 'Check out this shared file!' // Custom message for the notification
});

Important Notes #

• Field Mapping for value: The v2 value field was replaced in v3 to be more explicit:
  • For user or group permissions: Use emailAddress
  • For domain permissions: Use domain
  • For anyone permissions: Omit this field entirely
• Type Safety: Using gapi.client.drive.Permission ensures your payload adheres to the API's schema and catches errors at compile time.
• Update Type Definitions: Make sure you're using the latest version of @types/gapi.client.drive to avoid missing fields or outdated type definitions.

内容的提问来源于stack exchange，提问作者Dan Pettersson