Dart

OneDrive -- Search for Files

See more OneDrive Examples

Search for files within a hierarchy of items for items matching a query. You can search within a folder hierarhcy or a whole drive.

Note: This example requires Chilkat v9.5.0.97 or greater.

Dart

import 'package:chilkat/chilkat.dart';

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

  // Use your client ID, client secret, and tenant ID in the following lines
  final json = CkJsonObject();
  json.updateString('client_id', '2871da2c-8176-4b7f-869b-2311aa82e743');
  json.updateString('client_secret', '2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH');
  json.updateString('scope', 'https://graph.microsoft.com/.default');
  json.updateString('token_endpoint', 'https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token');

  final http = CkHttp();
  http.authToken = json.emit();

  // Sends the following GET request:

  // Search the entire drive like this:
  // If not using "me", then the path should be /v1.0/users/{id | userPrincipalName}/...
  // GET /v1.0/users/{user-id}/drive/root/search(q='{search-text}')

  // Or search under a particular folder like this:
  // GET /v1.0/users/{user-id}/drive/root:/{item-path}:/search(q='{search-text}')

  // This example will search for files in or under the "/Misc" directory, having "penguin" in the file path.
  http.setUrlVar('item_path', '/Misc');
  http.setUrlVar('search_text', 'penguins');
  http.setUrlVar('user_id', '4fe732c3-322e-4a6b-b729-2fd1eb5c6104');

  final sbResults = CkStringBuilder();
  try {
    http.quickGetSb('https://graph.microsoft.com/v1.0/users/{\$user_id}/drive/root:/{\$item_path}:/search(q=\'{\$search_text}\')', sbResults);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // The response should be JSON.
  json.emitCompact = false;
  json.loadSb(sbResults);

  // A successful response should return a status code of 200.
  if (http.lastStatus != 200) {
    print(json.emit());
    print('Response status = ${http.lastStatus}');
    return;
  }

  print(json.emit());
  print('--');

  // Iterate over the results in the JSON response:
  final lastMod = CkDateTime();
  final photoTaken = CkDateTime();
  var i = 0;
  final numItems = json.sizeOfArray('value');
  while (i < numItems) {
    json.i = i;
    print('-- DriveItem ${i + 1}');
    print('id: ${json.stringOf('value[i].id')}');
    print('name: ${json.stringOf('value[i].name')}');
    print('size: ${json.intOf('value[i].size')}');

    // Get the lastModifiedDateTime
    lastMod.setFromTimestamp(json.stringOf('value[i].fileSystemInfo.lastModifiedDateTime'));

    // Is this a folder?
    if (json.hasMember('value[i].folder')) {
      print('This is a folder with ${json.intOf('value[i].folder.childCount')} children');
    }

    if (json.hasMember('value[i].file')) {
      print('This is a file.');
      print('SHA1 hash: ${json.stringOf('value[i].file.hashes.sha1Hash')}');
      print('mimeType: ${json.stringOf('value[i].mimeType')}');
    }

    if (json.hasMember('value[i].image')) {
      print('This is an image.');
      print('height: ${json.intOf('value[i].image.height')}');
      print('width: ${json.intOf('value[i].image.width')}');
    }

    if (json.hasMember('value[i].photo')) {
      print('This is a photo.');
      photoTaken.setFromTimestamp(json.stringOf('value[i].photo.takenDateTime'));
      print('photo taken on ${photoTaken.getAsRfc822(true)}');
    }

    if (json.hasMember('value[i].audio')) {
      print('This is an audio file.');
      print('duration: ${json.intOf('value[i].audio.duration')}');
    }

    i++;
  }

  // Sample JSON OneDrive search response:

  // 	{
  // 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(driveItem)",
  // 	  "value": [
  // 	    {
  // 	      "@odata.type": "#microsoft.graph.driveItem",
  // 	      "@microsoft.graph.downloadUrl": "https://public.dm2301.livefilestore.com/y4m01N6dLIV7ditztcRwWDx2Jzf1qiwJNASFiHfajfZUuJnEMgHmIZTASy3lNzwUFHQgET0I11hzqCyb0A6I5jhI9FgFAJlBJHFrToT7QXj2xvCV46LOZVJASk79LEWRRM97aOhdOHhKeIl_HxoIWSl08sX3kGyC50RP72rDE7ERSVdZAa3CmMNkp6tRtfKI5wfJNqSx3NeqLQ6LxwBBY4KgniPQOgEna0G_MKTGDt10T4",
  // 	      "createdBy": {
  // 	        "user": {
  // 	          "displayName": "Matt Smith",
  // 	          "id": "3a33fceb9b74cc15"
  // 	        }
  // 	      },
  // 	      "createdDateTime": "2017-06-04T20:40:22.48Z",
  // 	      "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NzIuMjU3",
  // 	      "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODcyLjI",
  // 	      "id": "3A33FCEB9B74CC15!4872",
  // 	      "lastModifiedBy": {
  // 	        "user": {
  // 	          "displayName": "Matt Smith",
  // 	          "id": "3a33fceb9b74cc15"
  // 	        }
  // 	      },
  // 	      "lastModifiedDateTime": "2017-06-04T20:40:23.463Z",
  // 	      "name": "penguins.jpg",
  // 	      "parentReference": {
  // 	        "driveId": "3a33fceb9b74cc15",
  // 	        "id": "3A33FCEB9B74CC15!4871",
  // 	        "name": "wildlife",
  // 	        "path": "/drive/root:/Misc/wildlife"
  // 	      },
  // 	      "size": 777835,
  // 	      "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pgg",
  // 	      "file": {
  // 	        "hashes": {
  // 	          "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
  // 	        },
  // 	        "mimeType": "image/jpeg"
  // 	      },
  // 	      "fileSystemInfo": {
  // 	        "createdDateTime": "2017-06-04T20:40:22.48Z",
  // 	        "lastModifiedDateTime": "2009-07-14T05:32:31.674Z"
  // 	      },
  // 	      "image": {
  // 	        "height": 768,
  // 	        "width": 1024
  // 	      },
  // 	      "photo": {
  // 	        "takenDateTime": "2008-02-18T05:07:31Z"
  // 	      },
  // 	      "searchResult": {
  // 	        "onClickTelemetryUrl": "https://www.bing.com/personalsearchclick?IG=D10F15177AE54D49A97F361270D53290&CID=3A33FCEB9B74CC150000000000000000&ID=DevEx%2c5005&q=penguins&resid=3A33FCEB9B74CC15%214872"
  // 	      }
  // 	    }
  // 	  ]
  // 	}
}