Swift Requires Chilkat v11.5.0+

SharePoint List Document Libraries

See more SharePoint Examples

This example shows how to use Chilkat's HttpCurl class to list the document libraries in a SharePoint site. In Microsoft Graph, SharePoint document libraries are represented as drives. The example demonstrates how HttpCurl can automatically resolve a SharePoint site name to its Microsoft Graph site ID, then use that ID to retrieve and display the site's document libraries.

Swift

func chilkatTest() {
    var success: Bool = false

    //  This example retrieves the document libraries for a SharePoint site.
    //  
    //  In Microsoft Graph terminology, a document library is represented as a "drive".
    //  The example demonstrates how HttpCurl can automatically resolve a SharePoint
    //  site name to a site ID before requesting the site's document libraries.

    success = false

    //  --------------------------------------------------------------------------------------------------------
    //  Before running this example, create an Azure App Registration and grant it
    //  the Microsoft Graph permissions required to access SharePoint.
    //  
    //  The application will authenticate using OAuth2 Client Credentials.
    //  See:
    //  How to Create SharePoint App Registration for OAuth 2.0 Client Credentials
    //  --------------------------------------------------------------------------------------------------------

    //  Build a JSON authentication configuration.
    //  HttpCurl will use this information to automatically obtain OAuth2 access tokens.
    let jsonAuth = CkoJsonObject()!

    //  Enable secret lookup.
    //  
    //  Instead of hard-coding sensitive values such as the client ID,
    //  client secret, and token endpoint, secret specification strings
    //  are used.  Chilkat automatically retrieves the actual values from
    //  Windows Credential Manager (Windows) or Apple Keychain (macOS).
    //  
    //  See:
    //  Secret Specification Strings
    jsonAuth.enableSecrets = true

    success = jsonAuth.updateString(jsonPath: "oauth2.client_id", value: "!!sharepoint|oauth2|client_id")
    if success == true {
        success = jsonAuth.updateString(jsonPath: "oauth2.client_secret", value: "!!sharepoint|oauth2|client_secret")
    }

    if success == true {
        success = jsonAuth.updateString(jsonPath: "oauth2.token_endpoint", value: "!!sharepoint|oauth2|token_endpoint")
    }

    if success == false {
        print("\(jsonAuth.lastErrorText!)")
        return
    }

    //  Request Microsoft Graph permissions that were granted to the application.
    jsonAuth.updateString(jsonPath: "oauth2.scope", value: "https://graph.microsoft.com/.default")

    //  ---------------------------------------------------------------------------------------------------

    let curl = CkoHttpCurl()!

    //  Associate the OAuth2 configuration with HttpCurl.
    //  
    //  When the request is executed, Chilkat automatically obtains an access token
    //  if needed and adds the Authorization: Bearer header to the HTTP request.
    curl.setAuth(json: jsonAuth)

    //  Define variables whose values are already known.
    //  
    //  These variables are referenced in the curl command using
    //  {{variable_name}} substitution syntax.
    curl.setVar(varName: "sharepoint_hostname", varValue: "example.sharepoint.com")
    curl.setVar(varName: "site_name", varValue: "test")

    //  The document libraries endpoint requires a Microsoft Graph site ID.
    //  
    //  Because the application only knows the SharePoint site name,
    //  HttpCurl must first retrieve the corresponding site ID.
    //  
    //  Define a function that can resolve the site_id variable when needed.
    //  HttpCurl may execute this function automatically if it determines that
    //  site_id is required by another request.
    curl.addFunction(funcName: "getSite", curl: "GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}")

    //  Extract the "id" field from the getSite response and store it
    //  in the HttpCurl variable named "site_id".
    //  
    //  Any later request that references {{site_id}} can use this value.
    curl.addOutput(funcName: "getSite", jsonPath: "id", varName: "site_id")

    //  The target Microsoft Graph request:
    //  
    //  curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives
    //  
    //  This request returns the document libraries belonging to the site.
    //  
    //  Microsoft Graph refers to document libraries as "drives",
    //  so each object in the response represents one document library.
    //  
    //  No Authorization header is included because HttpCurl automatically
    //  adds it when OAuth2 authentication is configured.
    var curlCommand: String? = "curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives\""

    //  Execute the request.
    //  
    //  HttpCurl examines the target curl command and determines that
    //  the variable {{site_id}} is required.
    //  
    //  Because site_id is not yet known, HttpCurl searches for a function
    //  capable of producing it.  The getSite function provides the "id"
    //  output, which is mapped to the site_id variable.
    //  
    //  The execution plan becomes:
    //  
    //    1) Execute getSite to obtain site_id.
    //    2) Substitute {{site_id}} into the target request.
    //    3) Execute the drives request.
    //  
    //  The final HTTP response returned by DoYourThing is always the
    //  response from the target curl command, which is the last step in the plan.
    success = curl.doYourThing(targetCurl: curlCommand)
    if success == false {
        print("\(curl.lastErrorText!)")
        return
    }

    //  A successful Graph response should return HTTP 200.
    //  Any other status code typically indicates an authentication,
    //  permission, or resource lookup error.
    var statusCode: Int = curl.statusCode.intValue
    if statusCode != 200 {
        print("\(curl.responseBodyStr!)")
        print("status code = \(statusCode)")
        return
    }

    //  The response body contains a JSON array named "value".
    //  Each element of the array describes a SharePoint document library.
    let json = CkoJsonObject()!
    json.emitCompact = false
    curl.getResponseJson(json: json)
    print("\(json.emit()!)")

    //  Iterate over the document libraries returned by Microsoft Graph
    //  and display selected properties for each library.
    var i: Int = 0
    var numDrives: Int = json.size(ofArray: "value").intValue
    while i < numDrives {
        json.i = i
        print("name: \(json.string(of: "value[i].name")!)")
        print("description: \(json.string(of: "value[i].description")!)")
        print("id: \(json.string(of: "value[i].id")!)")
        print("webUrl: \(json.string(of: "value[i].webUrl")!)")
        print("displayName: \(json.string(of: "value[i].createdBy.user.displayName")!)")
        print("-")
        i = i + 1
    }

    print("Success.")

}