B4X

Page Through All Contacts

See more Google APIs Examples

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

Dim success As Boolean = 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 ChilkatJsonObject
jsonToken.Initialize
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If success <> True Then
    Log("Failed to load googleContacts.json")
    Return
End If


Dim gAuth As ChilkatAuthGoogle
gAuth.Initialize("gAuth")
gAuth.AccessToken = jsonToken.StringOf("access_token")

Dim rest As ChilkatRest
rest.Initialize("rest")

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

'  Provide the authentication credentials (i.e. the access token)
rest.SetAuthGoogle(gAuth)

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

Dim startIndex As Int = 1
Dim maxResults As Int = 25
'  The totalResults will get updated with the correct value in the 1st loop iteration..
Dim totalResults As Int = 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 ChilkatStringBuilder
sbMaxResults.Initialize
sbMaxResults.AppendInt(maxResults)
Dim sbStartIndex As ChilkatStringBuilder
sbStartIndex.Initialize

Dim loopIteration As Int = 0
Do While startIndex <= totalResults

    sbStartIndex.Clear
    sbStartIndex.AppendInt(startIndex)

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

    Dim sbResponseBody As ChilkatStringBuilder
    sbResponseBody.Initialize
    success = rest.FullRequestNoBodySb("GET", "/m8/feeds/contacts/default/full", sbResponseBody)
    If success <> True Then
        Log(rest.LastErrorText)
        Return
    End If


    '  A successful response will have a status code equal to 200.
    If rest.ResponseStatusCode <> 200 Then
        Log("response status code = " & rest.ResponseStatusCode)
        Log("response status text = " & rest.ResponseStatusText)
        Log("response header: " & rest.ResponseHeader)
        Log("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 ChilkatXml
    xml.Initialize
    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 Int = xml.GetChildIntValue("openSearch:startIndex")
    Dim itemsPerPage As Int = xml.GetChildIntValue("openSearch:itemsPerPage")
    Log("totalResults = " & totalResults)
    Log("startIndex = " & startIndex2)
    Log("itemsPerPage = " & itemsPerPage)

    '  Iterate over each contact.
    Dim numEntries As Int = xml.NumChildrenHavingTag("entry")
    Dim i As Int = 0
    Do While i < numEntries
        xml.I = i
        Log((loopIteration * maxResults + i + 1) & " ----")
        Log("title: " & xml.GetChildContent("entry[i]|title"))

        Dim idUrl As String = xml.GetChildContent("entry[i]|id")
        Log("id: " & idUrl)

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


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


        '  Find the photo link and check to see if this contact has a photo.
        Dim xLink As ChilkatXml = 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 = xLink.HasAttribute("gd:etag")
            If bHasPhoto = True Then
                Log("This contact has a photo.")
            End If


        End If


        i = i + 1
    Loop

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
Loop