PureBasic

OneDrive -- List Large Directory

See more OneDrive Examples

Demonstrates how to get the entire collection of DriveItem children when the collection is large and multiple pages need to be requested. To test this example, I created a DriveItem with 450 children.

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

PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; This example uses the OAuth client credentials flow.
    ; See How to Create an Azure App Registration for OAuth 2.0 Client Credentials

    ; Use your client ID, client secret, and tenant ID in the following lines
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"client_id","2871da2c-8176-4b7f-869b-2311aa82e743")
    CkJsonObject::ckUpdateString(json,"client_secret","2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH")
    CkJsonObject::ckUpdateString(json,"scope","https://graph.microsoft.com/.default")
    CkJsonObject::ckUpdateString(json,"token_endpoint","https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token")

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

    CkHttp::setCkAuthToken(http, CkJsonObject::ckEmit(json))

    ; This example will get the DriveItems in /lots-of-files, which has 450 children..
    CkHttp::ckSetUrlVar(http,"item_path","/lots-of-files")
    CkHttp::ckSetUrlVar(http,"user_id","4fe732c3-322e-4a6b-b729-2fd1eb5c6104")

    resp.s
    i.i
    numItems.i

    CkJsonObject::setCkEmitCompact(json, 0)

    ; This loop will download DriveItems in sets of 25 until no more exist.
    bGetMore.i = 1
    ; (Add the $top query parameter to define the page size, i.e. the max number of results to return).
    nextLink.s = "https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:{$item_path}:/children?$top=25"

    While (bGetMore = 1)

        ; Get the next chunk of DriveItems
        resp = CkHttp::ckQuickGetStr(http,nextLink)
        If CkHttp::ckLastMethodSuccess(http) <> 1
            Debug CkHttp::ckLastErrorText(http)
            CkJsonObject::ckDispose(json)
            CkHttp::ckDispose(http)
            ProcedureReturn
        EndIf

        ; The response should be JSON.
        CkJsonObject::ckLoad(json,resp)

        ; 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))
            CkJsonObject::ckDispose(json)
            CkHttp::ckDispose(http)
            ProcedureReturn
        EndIf

        ; Iterate over the DriveItems in the JSON response:
        i = 0
        numItems = CkJsonObject::ckSizeOfArray(json,"value")
        While i < numItems
            CkJsonObject::setCkI(json, i)
            Debug "name: " + CkJsonObject::ckStringOf(json,"value[i].name")
            i = i + 1
        Wend

        ; If a nextLink was included in the JSON, use it to get the next set of 50 DriveItems.
        ; Otherwise, exit the loop.
        If CkJsonObject::ckHasMember(json,Chr(34) + "@odata.nextLink" + Chr(34)) = 1
            nextLink = CkJsonObject::ckStringOf(json,Chr(34) + "@odata.nextLink" + Chr(34))
            Debug "nextLink: " + nextLink
        Else
            bGetMore = 0
        EndIf

    Wend


    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)


    ProcedureReturn
EndProcedure