(Lianja) Page Through All Contacts

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/googleContacts.json")
if (llSuccess <> .T.) then
    ? "Failed to load googleContacts.json"
    release loJsonToken
    return
endif

loGAuth = createobject("CkAuthGoogle")
loGAuth.AccessToken = loJsonToken.StringOf("access_token")

loRest = createobject("CkRest")

// Connect using TLS.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("www.google.com",443,.T.,llBAutoReconnect)

// Provide the authentication credentials (i.e. the access token)
loRest.SetAuthGoogle(loGAuth)

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

lnStartIndex = 1
lnMaxResults = 25
// The totalResults will get updated with the correct value in the 1st loop iteration..
lnTotalResults = 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

loSbMaxResults = createobject("CkStringBuilder")
loSbMaxResults.AppendInt(lnMaxResults)
loSbStartIndex = createobject("CkStringBuilder")

lnLoopIteration = 0
do while lnStartIndex <= lnTotalResults

    loSbStartIndex.Clear()
    loSbStartIndex.AppendInt(lnStartIndex)

    loRest.ClearAllHeaders()
    loRest.ClearAllQueryParams()
    loRest.AddHeader("GData-Version","3.0")
    loRest.AddQueryParam("start-index",loSbStartIndex.GetAsString())
    loRest.AddQueryParam("max-results",loSbMaxResults.GetAsString())

    loSbResponseBody = createobject("CkStringBuilder")
    llSuccess = loRest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",loSbResponseBody)
    if (llSuccess <> .T.) then
        ? loRest.LastErrorText
        release loJsonToken
        release loGAuth
        release loRest
        release loSbMaxResults
        release loSbStartIndex
        release loSbResponseBody
        return
    endif

    // A successful response will have a status code equal to 200.
    if (loRest.ResponseStatusCode <> 200) then
        ? "response status code = " + str(loRest.ResponseStatusCode)
        ? "response status text = " + loRest.ResponseStatusText
        ? "response header: " + loRest.ResponseHeader
        ? "response body: " + loSbResponseBody.GetAsString()
        release loJsonToken
        release loGAuth
        release loRest
        release loSbMaxResults
        release loSbStartIndex
        release loSbResponseBody
        return
    endif

    // If the 200 response was received, then the contacts XML is contained
    // in the response body.
    loXml = createobject("CkXml")
    loXml.LoadSb(loSbResponseBody,.F.)

    // 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.
    lnTotalResults = loXml.GetChildIntValue("openSearch:totalResults")
    lnStartIndex2 = loXml.GetChildIntValue("openSearch:startIndex")
    lnItemsPerPage = loXml.GetChildIntValue("openSearch:itemsPerPage")
    ? "totalResults = " + str(lnTotalResults)
    ? "startIndex = " + str(lnStartIndex2)
    ? "itemsPerPage = " + str(lnItemsPerPage)

    // Iterate over each contact.
    lnNumEntries = loXml.NumChildrenHavingTag("entry")
    i = 0
    do while i < lnNumEntries
        loXml.I = i
        ? str(lnLoopIteration * lnMaxResults + i + 1) + " ----"
        ? "title: " + loXml.GetChildContent("entry[i]|title")

        lcIdUrl = loXml.GetChildContent("entry[i]|id")
        ? "id: " + lcIdUrl

        lcFullName = loXml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
        if (loXml.LastMethodSuccess = .T.) then
            ? "fullName: " + lcFullName
        endif

        lcEmailAddress = loXml.ChilkatPath("entry[i]|gd:email|(address)")
        if (loXml.LastMethodSuccess = .T.) then
            ? "email address: " + lcEmailAddress
        endif

        // Find the photo link and check to see if this contact has a photo.
        loXLink = loXml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo")
        if (loXml.LastMethodSuccess = .T.) then
            // Get the photo etag.
            llBHasPhoto = loXLink.HasAttribute("gd:etag")
            if (llBHasPhoto = .T.) then
                ? "This contact has a photo."
            endif

            release loXLink
        endif

        i = i + 1
    enddo

    lnStartIndex = lnStartIndex + lnMaxResults
    lnLoopIteration = lnLoopIteration + 1
enddo


release loJsonToken
release loGAuth
release loRest
release loSbMaxResults
release loSbStartIndex
release loSbResponseBody
release loXml