(Xojo Plugin) Find Contact Having Email Address

Demonstrates how to fetch the Google Contact for a given email address.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

// To retrieve the contacts, we need to send the following:

// 	GET /m8/feeds/contacts/default/full?q=<emailAddress>
// 	GData-Version: 3.0

// Get the contact (or contacts) with this email address:
Dim emailAddressToFind As String
emailAddressToFind = "admin@chilkatsoft.com"

success = rest.AddHeader("GData-Version","3.0")
success = rest.AddQueryParam("q",emailAddressToFind)

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)

// See below for a sample response body.
success = xml.SaveXml("qa_output/google_contacts.xml")

// 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.
Dim totalResults As Int32
totalResults = xml.GetChildIntValue("openSearch:totalResults")
Dim startIndex As Int32
startIndex = xml.GetChildIntValue("openSearch:startIndex")
Dim itemsPerPage As Int32
itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
System.DebugLog("totalResults = " + Str(totalResults))
System.DebugLog("startIndex = " + Str(startIndex))
System.DebugLog("itemsPerPage = " + Str(itemsPerPage))

// We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
Dim fac As New Chilkat.FileAccess

// 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(i + 1) + " ----")
    System.DebugLog("title: " + xml.GetChildContent("entry[i]|title"))

    // The entry "id" child contains a URL having this format:
    // <id>http://www.google.com/m8/feeds/contacts/{userEmail}/base/{contactId}</id>
    // Let's get the URL and parse the contactId from it..
    Dim idUrl As String
    idUrl = xml.GetChildContent("entry[i]|id")
    System.DebugLog("id: " + idUrl)

    // Use the parsing ability of GetFileName to get the contactId
    Dim contactId As String
    contactId = fac.GetFileName(idUrl)
    System.DebugLog("contactId: " + contactId)

    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

    i = i + 1
Wend