Node.js

Page Through All Contacts

See more Google APIs Examples

Demonstrates how to page through the entire list of Google Contacts. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    // --------------------------------------------------------------------------------------------------------
    // Note: The code for setting up the Chilkat REST object and making the initial connection can be done once.
    // Once connected, the REST object may be re-used for many REST API calls.
    // (It's a good idea to put the connection setup code in a separate function/subroutine.)
    // --------------------------------------------------------------------------------------------------------

    // It is assumed we previously obtained an OAuth2 access token.
    // This example loads the JSON access token file 
    // saved by this example: Get Google Contacts OAuth2 Access Token

    var jsonToken = new chilkat.JsonObject();
    success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json");
    if (success !== true) {
        console.log("Failed to load googleContacts.json");
        return;
    }

    var gAuth = new chilkat.AuthGoogle();
    gAuth.AccessToken = jsonToken.StringOf("access_token");

    var rest = new chilkat.Rest();

    // Connect using TLS.
    var bAutoReconnect = true;
    success = rest.Connect("www.google.com",443,true,bAutoReconnect);

    // Provide the authentication credentials (i.e. the access token)
    rest.SetAuthGoogle(gAuth);

    // ----------------------------------------------
    // OK, the REST connection setup is completed..
    // ----------------------------------------------

    var startIndex = 1;
    var maxResults = 25;
    // The totalResults will get updated with the correct value in the 1st loop iteration..
    var totalResults = 100;
    // To retrieve the contacts in pages of 25 each, we need to send the following for each page.

    // 	GET /m8/feeds/contacts/default/full?max-results=25&start-index=<startIndex>
    // 	GData-Version: 3.0

    var sbMaxResults = new chilkat.StringBuilder();
    sbMaxResults.AppendInt(maxResults);
    var sbStartIndex = new chilkat.StringBuilder();

    var loopIteration = 0;
    while (startIndex <= totalResults) {

        sbStartIndex.Clear();
        sbStartIndex.AppendInt(startIndex);

        rest.ClearAllHeaders();
        rest.ClearAllQueryParams();
        rest.AddHeader("GData-Version","3.0");
        rest.AddQueryParam("start-index",sbStartIndex.GetAsString());
        rest.AddQueryParam("max-results",sbMaxResults.GetAsString());

        var sbResponseBody = new chilkat.StringBuilder();
        success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody);
        if (success !== true) {
            console.log(rest.LastErrorText);
            return;
        }

        // A successful response will have a status code equal to 200.
        if (rest.ResponseStatusCode !== 200) {
            console.log("response status code = " + rest.ResponseStatusCode);
            console.log("response status text = " + rest.ResponseStatusText);
            console.log("response header: " + rest.ResponseHeader);
            console.log("response body: " + sbResponseBody.GetAsString());
            return;
        }

        // If the 200 response was received, then the contacts XML is contained
        // in the response body.
        var xml = new chilkat.Xml();
        xml.LoadSb(sbResponseBody,false);

        // Now let's parse the XML...

        // Get the the total number of results, the start index, and the items per page.
        // We'll likely NOT get the full list, but will instead get the 1st page.
        totalResults = xml.GetChildIntValue("openSearch:totalResults");
        var startIndex2 = xml.GetChildIntValue("openSearch:startIndex");
        var itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage");
        console.log("totalResults = " + totalResults);
        console.log("startIndex = " + startIndex2);
        console.log("itemsPerPage = " + itemsPerPage);

        // Iterate over each contact.
        var numEntries = xml.NumChildrenHavingTag("entry");
        var i = 0;
        while (i < numEntries) {
            xml.I = i;
            console.log((loopIteration * maxResults+i+1) + " ----");
            console.log("title: " + xml.GetChildContent("entry[i]|title"));

            var idUrl = xml.GetChildContent("entry[i]|id");
            console.log("id: " + idUrl);

            var fullName = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*");
            if (xml.LastMethodSuccess == true) {
                console.log("fullName: " + fullName);
            }

            var emailAddress = xml.ChilkatPath("entry[i]|gd:email|(address)");
            if (xml.LastMethodSuccess == true) {
                console.log("email address: " + emailAddress);
            }

            // Find the photo link and check to see if this contact has a photo.
            // xLink: Xml
            var xLink = xml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo");
            if (xml.LastMethodSuccess == true) {
                // Get the photo etag.
                var bHasPhoto = xLink.HasAttribute("gd:etag");
                if (bHasPhoto == true) {
                    console.log("This contact has a photo.");
                }

            }

            i = i+1;
        }

        startIndex = startIndex+maxResults;
        loopIteration = loopIteration+1;
    }


}

chilkatExample();