(Android™) 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.

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    http.put_Login("SHAREPOINT_USERNAME");
    http.put_Password("SHAREPOINT_PASSWORD");
    http.put_LoginDomain("SHAREPOINT_NTLM_DOMAIN");
    http.put_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

    // Indicate that we want a JSON reply
    http.put_Accept("application/json;odata=verbose");
    http.put_AcceptCharset("utf-8");

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

    String jsonReply = http.quickGetStr(url);
    if (http.get_LastMethodSuccess() != true) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    // Examine the file's metadata in JSON format.
    CkJsonObject json = new CkJsonObject();
    json.Load(jsonReply);
    json.put_EmitCompact(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 (http.get_LastStatus() != 200) {
        Log.i(TAG, json.emit());
        Log.i(TAG, "Failed.");
        return;
        }

    Log.i(TAG, json.emit());

    Log.i(TAG, "--------");
    Log.i(TAG, "Server relative URL: " + json.stringOf("d.ServerRelativeUrl"));

    int fileSize = json.IntOf("d.Length");
    Log.i(TAG, "File Size = " + String.valueOf(fileSize));

    CkDateTime lastmod = new CkDateTime();
    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:
    boolean bLocalTime = false;
    Log.i(TAG, 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 = true;
    Log.i(TAG, 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);
    Log.i(TAG, "Unix time: " + String.valueOf(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:
    CkDtObj dtObj = lastmod.GetDtObj(bLocalTime);
    if (lastmod.get_LastMethodSuccess() == false) {
        Log.i(TAG, "This should never really happen!");
        return;
        }

    Log.i(TAG, String.valueOf(dtObj.get_Day()) + "-" + String.valueOf(dtObj.get_Month()) + "-" + String.valueOf(dtObj.get_Year())
         + " " + String.valueOf(dtObj.get_Hour()) + ":" + String.valueOf(dtObj.get_Minute()) + ":" + String.valueOf(dtObj.get_Second()));

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

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}