Visual FoxPro

Page Through All Contacts

See more Google APIs Examples

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

LOCAL lnSuccess
LOCAL loJsonToken
LOCAL loGAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lnStartIndex
LOCAL lnMaxResults
LOCAL lnTotalResults
LOCAL loSbMaxResults
LOCAL loSbStartIndex
LOCAL lnLoopIteration
LOCAL loSbResponseBody
LOCAL loXml
LOCAL lnStartIndex2
LOCAL lnItemsPerPage
LOCAL lnNumEntries
LOCAL i
LOCAL lcIdUrl
LOCAL lcFullName
LOCAL lcEmailAddress
LOCAL loXLink
LOCAL lnBHasPhoto

lnSuccess = 0

* 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('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/googleContacts.json")
IF (lnSuccess <> 1) THEN
    ? "Failed to load googleContacts.json"
    RELEASE loJsonToken
    CANCEL
ENDIF

loGAuth = CreateObject('Chilkat.AuthGoogle')
loGAuth.AccessToken = loJsonToken.StringOf("access_token")

loRest = CreateObject('Chilkat.Rest')

* Connect using TLS.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("www.google.com",443,1,lnBAutoReconnect)

* 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('Chilkat.StringBuilder')
loSbMaxResults.AppendInt(lnMaxResults)
loSbStartIndex = CreateObject('Chilkat.StringBuilder')

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('Chilkat.StringBuilder')
    lnSuccess = loRest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",loSbResponseBody)
    IF (lnSuccess <> 1) THEN
        ? loRest.LastErrorText
        RELEASE loJsonToken
        RELEASE loGAuth
        RELEASE loRest
        RELEASE loSbMaxResults
        RELEASE loSbStartIndex
        RELEASE loSbResponseBody
        CANCEL
    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
        CANCEL
    ENDIF

    * If the 200 response was received, then the contacts XML is contained
    * in the response body.
    loXml = CreateObject('Chilkat.Xml')
    loXml.LoadSb(loSbResponseBody,0)

    * 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 = 1) THEN
            ? "fullName: " + lcFullName
        ENDIF

        lcEmailAddress = loXml.ChilkatPath("entry[i]|gd:email|(address)")
        IF (loXml.LastMethodSuccess = 1) 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 = 1) THEN
            * Get the photo etag.
            lnBHasPhoto = loXLink.HasAttribute("gd:etag")
            IF (lnBHasPhoto = 1) 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