Dart

Download File (Stream to Local Filesystem)

See more Google Drive Examples

This example demonstrates how to download the content of a file from Google Drive. The file is streamed to the local filesystem. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // It requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  // This example uses a previously obtained access token having permission for the 
  // Google Drive scope.

  final gAuth = CkAuthGoogle();
  gAuth.accessToken = 'GOOGLE_DRIVE_ACCESS_TOKEN';

  final rest = CkRest();

  // Connect using TLS.
  // A single REST object, once connected, can be used for many Google Drive REST API calls.
  // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
  // then it will be automatically re-established as needed.
  final bAutoReconnect = true;
  rest.connect('www.googleapis.com', 443, true, bAutoReconnect);

  // Provide the authentication credentials (i.e. the access token)
  rest.setAuthGoogle(gAuth);

  // ------------------------------------------------------------------------------
  // To download a file, we must know the file ID.
  // In a previous example (see Build Local Metadata Cache
  // we built a local cache to make it easy to lookup file IDs given a file path.
  // Let's say we want to download "testFolder/abc/123/penguins.jpg".
  // First we lookup the fileId in the cache.  With the fileId, we can download the file.
  final gdCache = CkCache();
  gdCache.level = 0;
  gdCache.addRoot('C:/ckCache/googleDrive');

  final String fileId;
  try {
    fileId = gdCache.fetchText('testFolder/abc/123/penguins.jpg');
  } on ChilkatException {
    print('Filepath not found in cache.');
    return;
  }

  // We need to send a GET request like this:
  // GET https://www.googleapis.com/drive/v3/files/fileId?alt=media
  // The fileId is part of the path.
  final sbPath = CkStringBuilder();
  sbPath.append('/drive/v3/files/');
  sbPath.append(fileId);
  rest.addQueryParam('alt', 'media');

  // Create a stream object with a SinkFile set to the path where the downloaded file will go.
  final fileStream = CkStream();
  fileStream.sinkFile = 'qa_output/penguins.jpg';
  // Indicate that the response body should stream directly to fileStream,
  // but only if the response status is 200.  
  rest.setResponseBodyStream(200, true, fileStream);

  // Download the file, streaming the content to the SinkFile.
  final String jsonResponse;
  try {
    jsonResponse = rest.fullRequestNoBody('GET', sbPath.getAsString());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // A successful response will have a status code equal to 200.
  if (rest.responseStatusCode != 200) {
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    return;
  }

  print('File downloaded.');
}