Lua

Page Through All Contacts

See more Google APIs Examples

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

local chilkat = require("chilkat")

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

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/googleContacts.json")
if not success then
    print("Failed to load googleContacts.json")
    return
end

local gAuth = chilkat.AuthGoogle.new()
gAuth.access_token = jsonToken:string_of("access_token")

local rest = chilkat.Rest.new()

-- Connect using TLS.
local bAutoReconnect = true
success = rest:connect("www.google.com", 443, true, bAutoReconnect)

-- Provide the authentication credentials (i.e. the access token)
rest:set_auth_google(gAuth)

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

local startIndex = 1
local maxResults = 25
-- The totalResults will get updated with the correct value in the 1st loop iteration..
local 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

local sbMaxResults = chilkat.StringBuilder.new()
sbMaxResults:append_int(maxResults)
local sbStartIndex = chilkat.StringBuilder.new()

local loopIteration = 0
while startIndex <= totalResults do
    sbStartIndex:clear()
    sbStartIndex:append_int(startIndex)

    rest:clear_all_headers()
    rest:clear_all_query_params()
    rest:add_header("GData-Version", "3.0")
    rest:add_query_param("start-index", sbStartIndex:get_as_string())
    rest:add_query_param("max-results", sbMaxResults:get_as_string())

    local sbResponseBody = chilkat.StringBuilder.new()
    success = rest:full_request_no_body_sb("GET", "/m8/feeds/contacts/default/full", sbResponseBody)
    if not success then
        print(rest.last_error_text)
        return
    end

    -- A successful response will have a status code equal to 200.
    if rest.response_status_code ~= 200 then
        print("response status code = " .. rest.response_status_code)
        print("response status text = " .. rest.response_status_text)
        print("response header: " .. rest.response_header)
        print("response body: " .. sbResponseBody:get_as_string())
        return
    end

    -- If the 200 response was received, then the contacts XML is contained
    -- in the response body.
    local xml = chilkat.Xml.new()
    xml:load_sb(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:get_child_int_value("openSearch:totalResults")
    local startIndex2 = xml:get_child_int_value("openSearch:startIndex")
    local itemsPerPage = xml:get_child_int_value("openSearch:itemsPerPage")
    print("totalResults = " .. totalResults)
    print("startIndex = " .. startIndex2)
    print("itemsPerPage = " .. itemsPerPage)

    -- Iterate over each contact.
    local numEntries = xml:num_children_having_tag("entry")
    local i = 0
    while i < numEntries do
        xml.i = i
        print((loopIteration * maxResults + i + 1) .. " ----")
        print("title: " .. xml:get_child_content("entry[i]|title"))

        local idUrl = xml:get_child_content("entry[i]|id")
        print("id: " .. idUrl)

        local fullName = xml:chilkat_path("entry[i]|gd:name|gd:fullName|*")
        if xml.last_method_success then
            print("fullName: " .. fullName)
        end

        local emailAddress = xml:chilkat_path("entry[i]|gd:email|(address)")
        if xml.last_method_success then
            print("email address: " .. emailAddress)
        end

        -- Find the photo link and check to see if this contact has a photo.
        local xLink = xml:get_child_with_attr("link", "rel", "http://schemas.google.com/contacts/2008/rel#photo")
        if xml.last_method_success then
            -- Get the photo etag.
            local bHasPhoto = xLink:has_attribute("gd:etag")
            if bHasPhoto then
                print("This contact has a photo.")
            end
        end

        i = i + 1
    end

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
end