(PureBasic) 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.68 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Use your previously obtained access token here:
    ; See the following examples for getting an access token:
    ;    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
    ;    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
    ;    Refresh Access Token (Azure AD v2.0 Endpoint).
    ;    Refresh Access Token (Azure AD Endpoint).

    ; (Make sure your token was obtained with the FilesRead or Files.ReadWrite scope.)
    CkHttp::setCkAuthToken(http, "MICROSOFT_GRAPH_ACCESS_TOKEN")

    ; 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/me/drive/root/search(q='{search-text}')

    ; Or search under a particular folder like this:
    ; GET /v1.0/me/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.
    CkHttp::ckSetUrlVar(http,"item_path","/Misc")
    CkHttp::ckSetUrlVar(http,"search_text","penguins")

    sbResults.i = CkStringBuilder::ckCreate()
    If sbResults.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/me/drive/root:/{$item_path}:/search(q='{$search_text}')",sbResults)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResults)
        ProcedureReturn
    EndIf

    ; The response should be JSON.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoadSb(json,sbResults)

    ; A successful response should return a status code of 200.
    If CkHttp::ckLastStatus(http) <> 200
        Debug CkJsonObject::ckEmit(json)
        Debug "Response status = " + Str(CkHttp::ckLastStatus(http))
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResults)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(json)
    Debug "--"

    ; Iterate over the results in the JSON response:
    lastMod.i = CkDateTime::ckCreate()
    If lastMod.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    photoTaken.i = CkDateTime::ckCreate()
    If photoTaken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    i.i = 0
    numItems.i = CkJsonObject::ckSizeOfArray(json,"value")
    While i < numItems
        CkJsonObject::setCkI(json, i)
        Debug "-- DriveItem " + Str(i + 1)
        Debug "id: " + CkJsonObject::ckStringOf(json,"value[i].id")
        Debug "name: " + CkJsonObject::ckStringOf(json,"value[i].name")
        Debug "size: " + Str(CkJsonObject::ckIntOf(json,"value[i].size"))

        ; Get the lastModifiedDateTime
        CkDateTime::ckSetFromTimestamp(lastMod,CkJsonObject::ckStringOf(json,"value[i].fileSystemInfo.lastModifiedDateTime"))

        ; Is this a folder?
        If CkJsonObject::ckHasMember(json,"value[i].folder") = 1
            Debug "This is a folder with " + Str(CkJsonObject::ckIntOf(json,"value[i].folder.childCount")) + " children"
        EndIf

        If CkJsonObject::ckHasMember(json,"value[i].file") = 1
            Debug "This is a file."
            Debug "SHA1 hash: " + CkJsonObject::ckStringOf(json,"value[i].file.hashes.sha1Hash")
            Debug "mimeType: " + CkJsonObject::ckStringOf(json,"value[i].mimeType")
        EndIf

        If CkJsonObject::ckHasMember(json,"value[i].image") = 1
            Debug "This is an image."
            Debug "height: " + Str(CkJsonObject::ckIntOf(json,"value[i].image.height"))
            Debug "width: " + Str(CkJsonObject::ckIntOf(json,"value[i].image.width"))
        EndIf

        If CkJsonObject::ckHasMember(json,"value[i].photo") = 1
            Debug "This is a photo."
            CkDateTime::ckSetFromTimestamp(photoTaken,CkJsonObject::ckStringOf(json,"value[i].photo.takenDateTime"))
            Debug "photo taken on " + CkDateTime::ckGetAsRfc822(photoTaken,1)
        EndIf

        If CkJsonObject::ckHasMember(json,"value[i].audio") = 1
            Debug "This is an audio file."
            Debug "duration: " + Str(CkJsonObject::ckIntOf(json,"value[i].audio.duration"))
        EndIf

        i = i + 1
    Wend

    ; 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"
    ; 	      }
    ; 	    }
    ; 	  ]
    ; 	}


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResults)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(lastMod)
    CkDateTime::ckDispose(photoTaken)


    ProcedureReturn
EndProcedure