Delphi DLL

SharePoint -- Get File Property

Demonstrates how to get a specific property of a SharePoint file. Any of the following properties can be retrieved:

Author: Gets a value that specifies the user who added the file.
CheckedOutByUser: Gets a value that returns the user who has checked out the file.
CheckInComment: Gets a value that returns the comment used when a document is checked in to a document library.
CheckOutType: Gets a value that indicates how the file is checked out of a document library. Represents an
ContentTag: Returns internal version of content, used to validate document equality for read purposes.
CustomizedPageStatus: Gets a value that specifies the customization status of the file. Represents an
ETag: Gets a value that specifies the ETag value.
Exists: Gets a value that specifies whether the file exists.
Length: Gets the size of the file in bytes, excluding the size of any Web Parts that are used in the file.
Level: Gets a value that specifies the publishing level of the file. Represents an
ListItemAllFields: Gets a value that specifies the list item field values for the list item corresponding to the file.
LockedByUser: Gets a value that returns the user that owns the current lock on the file.
MajorVersion: Gets a value that specifies the major version of the file.
MinorVersion: Gets a value that specifies the minor version of the file.
ModifiedBy: Gets a value that returns the user who last modified the file.
Name: Gets the name of the file including the extension.
ServerRelativeUrl: Gets the relative URL of the file based on the URL for the server.
TimeCreated: Gets a value that specifies when the file was created.
TimeLastModified: Gets a value that specifies when the file was last modified.
Title: Gets a value that specifies the display name of the file.
UiVersion: Gets a value that specifies the implementation-specific version identifier of the file.
UiVersionLabel: Gets a value that specifies the implementation-specific version identifier of the file.
Versions: Gets a value that returns a collection of file version objects that represent the versions of the file.

Chilkat Delphi DLL Downloads

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, JsonObject, Http;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
url: PWideChar;
jsonReply: PWideChar;
json: HCkJsonObject;
numVersions: Integer;
i: Integer;

begin
success := False;

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

http := CkHttp_Create();

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_putLogin(http,'SHAREPOINT_USERNAME');
CkHttp_putPassword(http,'SHAREPOINT_PASSWORD');
CkHttp_putLoginDomain(http,'SHAREPOINT_NTLM_DOMAIN');
CkHttp_putNtlmAuth(http,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

// Indicate that we want a JSON reply
CkHttp_putAccept(http,'application/json;odata=verbose');
CkHttp_putAcceptCharset(http,'utf-8');

// Get the Author property.
url := 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl(''/Documents/VCAC-document.docx'')/Author';

jsonReply := CkHttp__quickGetStr(http,url);
if (CkHttp_getLastMethodSuccess(http) <> True) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_Load(json,jsonReply);
CkJsonObject_putEmitCompact(json,False);

// 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 (CkHttp_getLastStatus(http) <> 200) then
  begin
    Memo1.Lines.Add(CkJsonObject__emit(json));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

Memo1.Lines.Add(CkJsonObject__emit(json));

// The Author property returns JSON looking like this:

// {
//   "d": {
//     "__metadata": {
//       "id": "Web/GetUserById(18)",
//       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)",
//       "type": "SP.User"
//     },
//     "Groups": {
//       "__deferred": {
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)/Groups"
//       }
//     },
//     "Id": 18,
//     "IsHiddenInUI": false,
//     "LoginName": "i:0#.w|mydomain\\msmith",
//     "Title": "Mike Smith",
//     "PrincipalType": 1,
//     "Email": "msmith@mydomain.com",
//     "IsSiteAdmin": false,
//     "UserId": {
//       "__metadata": {
//         "type": "SP.UserIdInfo"
//       },
//       "NameId": "s-1-5-21-3433503314-2897774614-343593928-1137",
//       "NameIdIssuer": "urn:office:idp:activedirectory"
//     }
//   }
// }
// 

// Get the Title and Email:
Memo1.Lines.Add('----');
Memo1.Lines.Add('Title: ' + CkJsonObject__stringOf(json,'d.Title'));
Memo1.Lines.Add('Email: ' + CkJsonObject__stringOf(json,'d.Email'));
Memo1.Lines.Add('----');

// --------------------------------------------------------------------

// Get the Versions property.
url := 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl(''/Documents/VCAC-document.docx'')/Versions';

jsonReply := CkHttp__quickGetStr(http,url);
if (CkHttp_getLastMethodSuccess(http) <> True) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

CkJsonObject_Load(json,jsonReply);
Memo1.Lines.Add(CkJsonObject__emit(json));

// The Versions JSON reply looks like this:

// {
//   "d": {
//     "results": [
//       {
//         "__metadata": {
//           "id": "a8d025e2-8255-4487-9edb-9e796ab2889c",
//           "type": "SP.FileVersion"
//         },
//         "CreatedBy": {
//           "__deferred": {
//             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
//           }
//         },
//         "CheckInComment": "",
//         "Created": "2016-03-15T02:22:26Z",
//         "ID": 1,
//         "IsCurrentVersion": false,
//         "Size": 21082,
//         "Url": "_vti_history/1/Documents/VCAC-document.docx",
//         "VersionLabel": "0.1"
//       },
//       {
//         "__metadata": {
//           "id": "8ab3eadd-9126-4f65-a2a3-3b0689c592d6",
//           "type": "SP.FileVersion"
//         },
//         "CreatedBy": {
//           "__deferred": {
//             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
//           }
//         },
//         "CheckInComment": "",
//         "Created": "2016-03-15T05:28:24Z",
//         "ID": 2,
//         "IsCurrentVersion": false,
//         "Size": 21082,
//         "Url": "_vti_history/2/Documents/VCAC-document.docx",
//         "VersionLabel": "0.2"
//       }
//     ]
//   }
// }
// 

// Get each VersionLabel, Size, and Url...
numVersions := CkJsonObject_SizeOfArray(json,'d.results');
i := 0;
while i < numVersions do
  begin
    CkJsonObject_putI(json,i);
    Memo1.Lines.Add('---- i = ' + IntToStr(i));
    Memo1.Lines.Add('VersionLabel: ' + CkJsonObject__stringOf(json,'d.results[i].VersionLabel'));
    Memo1.Lines.Add('Url: ' + CkJsonObject__stringOf(json,'d.results[i].Url'));
    Memo1.Lines.Add('Size: ' + IntToStr(CkJsonObject_IntOf(json,'d.results[i].Size')));
    i := i + 1;
  end;

// The output is:

// ---- i = 0
// VersionLabel: 0.1
// Url: _vti_history/1/Documents/VCAC-document.docx
// Size: 21082
// ---- i = 1
// VersionLabel: 0.2
// Url: _vti_history/2/Documents/VCAC-document.docx
// Size: 21082

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

end;