(Swift) SharePoint -- Download File

Demonstrates how to download a file from SharePoint located in the /Documents folder.

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    //  -------------------------------------------------------------------------
    //  The following comments apply to SharePoint Windows classic authentication.
    //  -------------------------------------------------------------------------
    //  For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
    //  The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
    //  The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
    //  Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
    //  for example, "chilkat" instead of "chilkat@mycompany.com"

    let http = CkoHttp()

    //  If SharePoint Windows classic authentication is used, then set the
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    http.Login = "SHAREPOINT_USERNAME"
    http.Password = "SHAREPOINT_PASSWORD"
    http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
    http.NtlmAuth = true

    //  -------------------------------------------------------------------------
    //  The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    //  If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    //  establish the cookie as shown at SharePoint Online Authentication
    //  -------------------------------------------------------------------------

    //  This example downloads the file named "Domain Name created for Exchange.docx"

    //  Note: I was initially confused by the "$value" part of the URL.
    //  When I see something like $value, I immediately think that it's some sort of
    //  variable or placeholder to be replaced with an actual value.  In this case,
    //  the "$value" is literally part of the URL.  It's not replace with anything.

    var url: String? = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('Domain Name created for Exchange.docx')/$value"
    var localFilePath: String? = "qa_output/x.docx"

    var success: Bool = http.Download(url, localFilePath: localFilePath)
    if success != true {
        print("\(http.LastErrorText)")
        return
    }

    print("File successfully downloaded from SharePoint.")

}