(JavaScript) SharePoint -- Recycle File (Move File to Recycle Bin)

Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.

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

var req = new CkHttpRequest();
req.HttpVerb = "POST";
req.Path = "/_api/web/GetFileByServerRelativeUrl('/ChilkatDocLibrary/sample.docx')/recycle";

// We must 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");

// Send the request to move the file to the recycle bin.
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;
}

var xml = new CkXml();
xml.LoadXml(resp.BodyStr);

// A successful response will return the 200 status code.
if (resp.StatusCode !== 200) {
    console.log("Response status code = " + resp.StatusCode);
    console.log(xml.GetXml());
    console.log("Failed");
    return;
}

// Show the XML response.
console.log(xml.GetXml());

// The GUID (identifier) of the item in the recycle bin is just the content
// of the single-node XML that is returned:
var guid = xml.Content;
console.log("GUID of recycle item = " + guid);

console.log("Success.");

// A successful XML response looks like this:

// <?xml version="1.0" encoding="utf-8" ?>
// <d:Recycle xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
//  xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
//  xmlns:georss="http://www.georss.org/georss"
//  xmlns:gml="http://www.opengis.net/gml"
//  m:type="Edm.Guid">
//     63b9924d-e9c1-4d7b-b1c2-e921ad85aa1c
// </d:Recycle>