Swift
Swift
Google Contacts - Retrieve All Contacts
See more Google APIs Examples
Demonstrates how to retrieve the full list of contacts for the Google Contacts API.Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = 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
let jsonToken = CkoJsonObject()!
success = jsonToken.loadFile(path: "qa_data/tokens/googleContacts.json")
if success != true {
print("Failed to load googleContacts.json")
return
}
let gAuth = CkoAuthGoogle()!
gAuth.accessToken = jsonToken.string(of: "access_token")
let rest = CkoRest()!
// Connect using TLS.
var bAutoReconnect: Bool = true
success = rest.connect(hostname: "www.google.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
// Provide the authentication credentials (i.e. the access token)
rest.setAuthGoogle(authProvider: gAuth)
// ----------------------------------------------
// OK, the REST connection setup is completed..
// ----------------------------------------------
// To retrieve the contacts, we need to send the following:
// GET /m8/feeds/contacts/default/full
// GData-Version: 3.0
rest.addHeader(name: "GData-Version", value: "3.0")
let sbResponseBody = CkoStringBuilder()!
success = rest.fullRequestNoBodySb(httpVerb: "GET", uriPath: "/m8/feeds/contacts/default/full", sb: sbResponseBody)
if success != true {
print("\(rest.lastErrorText!)")
return
}
// A successful response will have a status code equal to 200.
if rest.responseStatusCode.intValue != 200 {
print("response status code = \(rest.responseStatusCode.intValue)")
print("response status text = \(rest.responseStatusText!)")
print("response header: \(rest.responseHeader!)")
print("response body: \(sbResponseBody.getAsString()!)")
return
}
// If the 200 response was received, then the contacts XML is contained
// in the response body.
let xml = CkoXml()!
xml.loadSb(sb: sbResponseBody, autoTrim: false)
// See below for a sample response body.
xml.save(path: "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.
var totalResults: Int = xml.getChildIntValue(tagPath: "openSearch:totalResults").intValue
var startIndex: Int = xml.getChildIntValue(tagPath: "openSearch:startIndex").intValue
var itemsPerPage: Int = xml.getChildIntValue(tagPath: "openSearch:itemsPerPage").intValue
print("totalResults = \(totalResults)")
print("startIndex = \(startIndex)")
print("itemsPerPage = \(itemsPerPage)")
// We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
let fac = CkoFileAccess()!
// Iterate over each contact.
var numEntries: Int = xml.numChildrenHavingTag(tag: "entry").intValue
var i: Int = 0
while i < numEntries {
xml.i = i
print("\(i + 1) ----")
print("title: \(xml.getChildContent(tagPath: "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..
var idUrl: String? = xml.getChildContent(tagPath: "entry[i]|id")
print("id: \(idUrl!)")
// Use the parsing ability of GetFileName to get the contactId
var contactId: String? = fac.getFileName(path: idUrl)
print("contactId: \(contactId!)")
var fullName: String? = xml.chilkatPath(cmd: "entry[i]|gd:name|gd:fullName|*")
if xml.lastMethodSuccess == true {
print("fullName: \(fullName!)")
}
var emailAddress: String? = xml.chilkatPath(cmd: "entry[i]|gd:email|(address)")
if xml.lastMethodSuccess == true {
print("email address: \(emailAddress!)")
}
i = i + 1
}
// The response body XML looks something like this:
// <feed xmlns="http://www.w3.org/2005/Atom"
// xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"
// xmlns:gContact="http://schemas.google.com/contact/2008"
// xmlns:batch="http://schemas.google.com/gdata/batch"
// xmlns:gd="http://schemas.google.com/g/2005"
// gd:etag="feedEtag">
// <id>userEmail</id>
// <updated>2008-12-10T10:04:15.446Z</updated>
// <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
// <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
// <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
// <link rel="http://schemas.google.com/g/2005#batch" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full/batch"/>
// <link rel="self" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full?max-results=25"/>
// <author>
// <name>User</name>
// <email>userEmail</email>
// </author>
// <generator version="1.0" uri="http://www.google.com/m8/feeds">
// Contacts
// </generator>
// <openSearch:totalResults>349</openSearch:totalResults>
// <openSearch:startIndex>1</openSearch:startIndex>
// <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
// <entry gd:etag="contactEtag">
// <id>
// http://www.google.com/m8/feeds/contacts/userEmail/base/contactId
// </id>
// <updated>2008-12-10T04:45:03.331Z</updated>
// <app:edited xmlns:app="http://www.w3.org/2007/app">2008-12-10T04:45:03.331Z</app:edited>
// <category scheme="http://schemas.google.com/g/2005#kind"
// term="http://schemas.google.com/contact/2008#contact"/>
// <title>Fitzwilliam Darcy</title>
// <gd:name>
// <gd:fullName>Fitzwilliam Darcy</gd:fullName>
// </gd:name>
// <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*"
// href="https://www.google.com/m8/feeds/photos/media/userEmail/contactId"
// gd:etag="photoEtag"/>
// <link rel="self" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
// <link rel="edit" type="application/atom+xml"
// href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
// <gd:phoneNumber rel="http://schemas.google.com/g/2005#home"
// primary="true">
// 456
// </gd:phoneNumber>
// <gd:extendedProperty name="pet" value="hamster"/>
// <gContact:groupMembershipInfo deleted="false"
// href="http://www.google.com/m8/feeds/groups/userEmail/base/groupId"/>
// <gd:email rel="http://schemas.google.com/g/2005#other" address="darcyf@example.com" primary="true" />
// </entry>
// <!-- Other entries ... -->
// </feed>
//
}