Objective-C

SharePoint -- Get File Metadata (File Size, Last-Modified Date/Time, etc.)

See more SharePoint Examples

Demonstrates how to get a file's metdata, which includes the file size, last-modified date/time, name, server relative URL, etc. Objective-C

#import <CkoHttp.h>
#import <NSString.h>
#import <CkoJsonObject.h>
#import <CkoDateTime.h>
#import <CkoDtObj.h>

BOOL success = NO;

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

//  Indicate that we want a JSON reply
http.Accept = @"application/json;odata=verbose";
http.AcceptCharset = @"utf-8";

NSString *url = @"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')";

NSString *jsonReply = [http QuickGetStr: url];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

//  Examine the file's metadata in JSON format.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: jsonReply];
json.EmitCompact = NO;

//  Make sure it was a success response, and that we really have metadata.
//  If it was an error response, then the JSON is error information..
if ([http.LastStatus intValue] != 200) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

NSLog(@"%@",[json Emit]);

NSLog(@"%@",@"--------");
NSLog(@"%@%@",@"Server relative URL: ",[json StringOf: @"d.ServerRelativeUrl"]);

int fileSize = [[json IntOf: @"d.Length"] intValue];
NSLog(@"%@%d",@"File Size = ",fileSize);

CkoDateTime *lastmod = [[CkoDateTime alloc] init];
[lastmod SetFromTimestamp: [json StringOf: @"d.TimeLastModified"]];

//  Once we have the CkDateTime object, we can get the date/time in all sorts of formats:

//  Get as a RFC822 GMT string:
BOOL bLocalTime = NO;
NSLog(@"%@",[lastmod GetAsRfc822: bLocalTime]);

//  Get as an RFC822 string in the local timezone.
//  (remember, the daylight savings that existed at the given time in the past is applied)
bLocalTime = YES;
NSLog(@"%@",[lastmod GetAsRfc822: bLocalTime]);

//  Get as a 32-bit UNIX time (local or GMT..)
//  The Unix time is number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). 
int unixTime = [lastmod GetAsUnixTime: bLocalTime];
NSLog(@"%@%d",@"Unix time: ",unixTime);

//  One can also get the as a "DtObj" object for accessing the individual
//  parts of the date/time, such as month, day, year, hour, minute, etc.
//  The DtObj can be obtained in the GMT or local timezone:
CkoDtObj *dtObj = [[CkoDtObj alloc] init];
[lastmod ToDtObj: bLocalTime dtObj: dtObj];

if (lastmod.LastMethodSuccess == NO) {
    NSLog(@"%@",@"This should never really happen!");
    return;
}

NSLog(@"%d%@%d%@%d%@%d%@%d%@%d",[dtObj.Day intValue],@"-",[dtObj.Month intValue],@"-",[dtObj.Year intValue],@" ",[dtObj.Hour intValue],@":",[dtObj.Minute intValue]
    ,@":",[dtObj.Second intValue]);

//  -------------------------------------------------
//  The file's metadata look like this:

//  { 
//    "d": { 
//      "__metadata": { 
//        "id": "Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
//        "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
//        "type": "SP.File"
//      },
//      "Author": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Author"
//        }
//      },
//      "CheckedOutByUser": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/CheckedOutByUser"
//        }
//      },
//      "ListItemAllFields": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ListItemAllFields"
//        }
//      },
//      "LockedByUser": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/LockedByUser"
//        }
//      },
//      "ModifiedBy": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ModifiedBy"
//        }
//      },
//      "Versions": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Versions"
//        }
//      },
//      "CheckInComment": "",
//      "CheckOutType": 2,
//      "ContentTag": "{E2F05E75-B3EF-4826-8284-E572D3628A7D},9,10",
//      "CustomizedPageStatus": 0,
//      "ETag": "\"{E2F05E75-B3EF-4826-8284-E572D3628A7D},9\"",
//      "Exists": true,
//      "Length": "21082",
//      "Level": 2,
//      "MajorVersion": 0,
//      "MinorVersion": 3,
//      "Name": "VCAC-document.docx",
//      "ServerRelativeUrl": "/Documents/VCAC-document.docx",
//      "TimeCreated": "2016-03-04T12:38:01Z",
//      "TimeLastModified": "2017-01-16T04:44:31Z",
//      "Title": "",
//      "UIVersion": 3,
//      "UIVersionLabel": "0.3"
//    }
//  }
//