(JavaScript) SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// 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 will delete the file named "penguins2.jpg" 
// which is located in the "/Documents" folder.

var req = new CkHttpRequest();
req.HttpVerb = "POST";
req.Path = "/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')";

// We need to add a form digest value in the X-RequestDigest header field.
// See this example for details on
// how to get (and cache) a form digest value
req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST");

// Add additional required headers.
req.AddHeader("IF-MATCH","*");
req.AddHeader("X-HTTP-Method","DELETE");

// Send the POST using https (TLS). Port 443 is the default port for https.
var bUseTls = true;
var resp = new CkHttpResponse();
success = http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

// If failed, the response body contains XML 
var xml = new CkXml();
xml.LoadXml(resp.BodyStr);

if (resp.StatusCode !== 200) {
    console.log("Response status code = " + resp.StatusCode);
    console.log(xml.GetXml());

    // For example, if the file did not exist, this would be the XML response:
    // <?xml version="1.0" encoding="utf-8" ?>
    // <m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    //     <m:code>-2146232832, Microsoft.SharePoint.SPException</m:code>
    //     <m:message xml:lang="en-US">The file /Documents/penguins2.jpg does not exist.</m:message>
    // </m:error>
    // 

    console.log("Failed");
    return;
}

// If successful, the response body is empty.
console.log("Success.");