(Tcl) 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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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
set json [new_CkJsonObject]

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

set http [new_CkHttp]

CkHttp_put_AuthToken $http [CkJsonObject_emit $json]

# This example will get the DriveItems in /lots-of-files, which has 450 children..
CkHttp_SetUrlVar $http "item_path" "/lots-of-files"
CkHttp_SetUrlVar $http "user_id" "4fe732c3-322e-4a6b-b729-2fd1eb5c6104"

CkJsonObject_put_EmitCompact $json 0

# This loop will download DriveItems in sets of 25 until no more exist.
set bGetMore 1
# (Add the $top query parameter to define the page size, i.e. the max number of results to return).
set nextLink "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
    set resp [CkHttp_quickGetStr $http $nextLink]
    if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
        puts [CkHttp_lastErrorText $http]
        delete_CkJsonObject $json
        delete_CkHttp $http
        exit
    }

    # The response should be JSON.
    CkJsonObject_Load $json $resp

    # A successful response should return a status code of 200.
    if {[CkHttp_get_LastStatus $http] != 200} then {
        puts [CkJsonObject_emit $json]
        puts "Response status = [CkHttp_get_LastStatus $http]"
        delete_CkJsonObject $json
        delete_CkHttp $http
        exit
    }

    # Iterate over the DriveItems in the JSON response:
    set i 0
    set numItems [CkJsonObject_SizeOfArray $json "value"]
    while {$i < $numItems} {
        CkJsonObject_put_I $json $i
        puts "name: [CkJsonObject_stringOf $json {value[i].name}]"
        set i [expr $i + 1]
    }

    # If a nextLink was included in the JSON, use it to get the next set of 50 DriveItems.
    # Otherwise, exit the loop.
    if {[CkJsonObject_HasMember $json "\"@odata.nextLink\""] == 1} then {
        set nextLink [CkJsonObject_stringOf $json "\"@odata.nextLink\""]
        puts "nextLink: $nextLink"
    }     else {
        set bGetMore 0
    }

}

delete_CkJsonObject $json
delete_CkHttp $http