(Objective-C) 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.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
#import <CkoXml.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];

// 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 = YES;

// 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

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
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" value: @"SHAREPOINT_FORM_DIGEST"];

// Send the request to move the file to the recycle bin.
BOOL bUseTls = YES;
CkoHttpResponse *resp = [http SynchronousRequest: @"SHAREPOINT_HTTPS_DOMAIN" port: [NSNumber numberWithInt: 443] ssl: bUseTls req: req];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoXml *xml = [[CkoXml alloc] init];
[xml LoadXml: resp.BodyStr];

// A successful response will return the 200 status code.
if ([resp.StatusCode intValue] != 200) {
    NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",[xml GetXml]);
    NSLog(@"%@",@"Failed");

    return;
}

// Show the XML response.
NSLog(@"%@",[xml GetXml]);

// The GUID (identifier) of the item in the recycle bin is just the content
// of the single-node XML that is returned:
NSString *guid = xml.Content;
NSLog(@"%@%@",@"GUID of recycle item = ",guid);

NSLog(@"%@",@"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>