Xbase++

Page Through All Contacts

See more Google APIs Examples

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

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oGAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL nStartIndex
LOCAL nMaxResults
LOCAL nTotalResults
LOCAL oSbMaxResults
LOCAL oSbStartIndex
LOCAL nLoopIteration
LOCAL oSbResponseBody
LOCAL oXml
LOCAL nStartIndex2
LOCAL nItemsPerPage
LOCAL nNumEntries
LOCAL i
LOCAL cIdUrl
LOCAL cFullName
LOCAL cEmailAddress
LOCAL oXLink
LOCAL nBHasPhoto

nSuccess := 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

oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/googleContacts.json")
IF (nSuccess != 1)
    ? "Failed to load googleContacts.json"
    oJsonToken:destroy()
    RETURN
ENDIF

oGAuth := CreateObject("Chilkat.AuthGoogle")
oGAuth:AccessToken := oJsonToken:StringOf("access_token")

oRest := CreateObject("Chilkat.Rest")

//  Connect using TLS.
nBAutoReconnect := 1
nSuccess := oRest:Connect("www.google.com", 443, 1, nBAutoReconnect)

//  Provide the authentication credentials (i.e. the access token)
oRest:SetAuthGoogle(oGAuth)

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

nStartIndex := 1
nMaxResults := 25
//  The totalResults will get updated with the correct value in the 1st loop iteration..
nTotalResults := 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

oSbMaxResults := CreateObject("Chilkat.StringBuilder")
oSbMaxResults:AppendInt(nMaxResults)
oSbStartIndex := CreateObject("Chilkat.StringBuilder")

nLoopIteration := 0
DO WHILE nStartIndex <= nTotalResults

    oSbStartIndex:Clear()
    oSbStartIndex:AppendInt(nStartIndex)

    oRest:ClearAllHeaders()
    oRest:ClearAllQueryParams()
    oRest:AddHeader("GData-Version", "3.0")
    oRest:AddQueryParam("start-index", oSbStartIndex:GetAsString())
    oRest:AddQueryParam("max-results", oSbMaxResults:GetAsString())

    oSbResponseBody := CreateObject("Chilkat.StringBuilder")
    nSuccess := oRest:FullRequestNoBodySb("GET", "/m8/feeds/contacts/default/full", oSbResponseBody)
    IF (nSuccess != 1)
        ? oRest:LastErrorText
        oJsonToken:destroy()
        oGAuth:destroy()
        oRest:destroy()
        oSbMaxResults:destroy()
        oSbStartIndex:destroy()
        oSbResponseBody:destroy()
        RETURN
    ENDIF

    //  A successful response will have a status code equal to 200.
    IF (oRest:ResponseStatusCode != 200)
        ? "response status code = " + Str(oRest:ResponseStatusCode)
        ? "response status text = " + oRest:ResponseStatusText
        ? "response header: " + oRest:ResponseHeader
        ? "response body: " + oSbResponseBody:GetAsString()
        oJsonToken:destroy()
        oGAuth:destroy()
        oRest:destroy()
        oSbMaxResults:destroy()
        oSbStartIndex:destroy()
        oSbResponseBody:destroy()
        RETURN
    ENDIF

    //  If the 200 response was received, then the contacts XML is contained
    //  in the response body.
    oXml := CreateObject("Chilkat.Xml")
    oXml:LoadSb(oSbResponseBody, 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.
    nTotalResults := oXml:GetChildIntValue("openSearch:totalResults")
    nStartIndex2 := oXml:GetChildIntValue("openSearch:startIndex")
    nItemsPerPage := oXml:GetChildIntValue("openSearch:itemsPerPage")
    ? "totalResults = " + Str(nTotalResults)
    ? "startIndex = " + Str(nStartIndex2)
    ? "itemsPerPage = " + Str(nItemsPerPage)

    //  Iterate over each contact.
    nNumEntries := oXml:NumChildrenHavingTag("entry")
    i := 0
    DO WHILE i < nNumEntries
        oXml:I := i
        ? Str(nLoopIteration * nMaxResults + i + 1) + " ----"
        ? "title: " + oXml:GetChildContent("entry[i]|title")

        cIdUrl := oXml:GetChildContent("entry[i]|id")
        ? "id: " + cIdUrl

        cFullName := oXml:ChilkatPath("entry[i]|gd:name|gd:fullName|*")
        IF (oXml:LastMethodSuccess == 1)
            ? "fullName: " + cFullName
        ENDIF

        cEmailAddress := oXml:ChilkatPath("entry[i]|gd:email|(address)")
        IF (oXml:LastMethodSuccess == 1)
            ? "email address: " + cEmailAddress
        ENDIF

        //  Find the photo link and check to see if this contact has a photo.
        oXLink := oXml:GetChildWithAttr("link", "rel", "http://schemas.google.com/contacts/2008/rel#photo")
        IF (oXml:LastMethodSuccess == 1)
            //  Get the photo etag.
            nBHasPhoto := oXLink:HasAttribute("gd:etag")
            IF (nBHasPhoto == 1)
                ? "This contact has a photo."
            ENDIF

            oXLink:destroy()
        ENDIF

        i := i + 1
    ENDDO

    nStartIndex := nStartIndex + nMaxResults
    nLoopIteration := nLoopIteration + 1
ENDDO

oJsonToken:destroy()
oGAuth:destroy()
oRest:destroy()
oSbMaxResults:destroy()
oSbStartIndex:destroy()
oSbResponseBody:destroy()
oXml:destroy()