Xojo Plugin

Page Through All Contacts

See more Google APIs Examples

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

Dim success As Boolean
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

Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If (success <> True) Then
    System.DebugLog("Failed to load googleContacts.json")
    Return
End If

Dim gAuth As New Chilkat.AuthGoogle
gAuth.AccessToken = jsonToken.StringOf("access_token")

Dim rest As New Chilkat.Rest

// Connect using TLS.
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("www.google.com",443,True,bAutoReconnect)

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

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

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

Dim sbMaxResults As New Chilkat.StringBuilder
success = sbMaxResults.AppendInt(maxResults)
Dim sbStartIndex As New Chilkat.StringBuilder

Dim loopIteration As Int32
loopIteration = 0
While startIndex <= totalResults

    sbStartIndex.Clear 
    success = sbStartIndex.AppendInt(startIndex)

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

    Dim sbResponseBody As New Chilkat.StringBuilder
    success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody)
    If (success <> True) Then
        System.DebugLog(rest.LastErrorText)
        Return
    End If

    // A successful response will have a status code equal to 200.
    If (rest.ResponseStatusCode <> 200) Then
        System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
        System.DebugLog("response status text = " + rest.ResponseStatusText)
        System.DebugLog("response header: " + rest.ResponseHeader)
        System.DebugLog("response body: " + sbResponseBody.GetAsString())
        Return
    End If

    // If the 200 response was received, then the contacts XML is contained
    // in the response body.
    Dim xml As New Chilkat.Xml
    success = 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")
    Dim startIndex2 As Int32
    startIndex2 = xml.GetChildIntValue("openSearch:startIndex")
    Dim itemsPerPage As Int32
    itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
    System.DebugLog("totalResults = " + Str(totalResults))
    System.DebugLog("startIndex = " + Str(startIndex2))
    System.DebugLog("itemsPerPage = " + Str(itemsPerPage))

    // Iterate over each contact.
    Dim numEntries As Int32
    numEntries = xml.NumChildrenHavingTag("entry")
    Dim i As Int32
    i = 0
    While i < numEntries
        xml.I = i
        System.DebugLog(Str(loopIteration * maxResults + i + 1) + " ----")
        System.DebugLog("title: " + xml.GetChildContent("entry[i]|title"))

        Dim idUrl As String
        idUrl = xml.GetChildContent("entry[i]|id")
        System.DebugLog("id: " + idUrl)

        Dim fullName As String
        fullName = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
        If (xml.LastMethodSuccess = True) Then
            System.DebugLog("fullName: " + fullName)
        End If

        Dim emailAddress As String
        emailAddress = xml.ChilkatPath("entry[i]|gd:email|(address)")
        If (xml.LastMethodSuccess = True) Then
            System.DebugLog("email address: " + emailAddress)
        End If

        // Find the photo link and check to see if this contact has a photo.
        Dim xLink As Chilkat.Xml
        xLink = xml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo")
        If (xml.LastMethodSuccess = True) Then
            // Get the photo etag.
            Dim bHasPhoto As Boolean
            bHasPhoto = xLink.HasAttribute("gd:etag")
            If (bHasPhoto = True) Then
                System.DebugLog("This contact has a photo.")
            End If

        End If

        i = i + 1
    Wend

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
Wend