DataFlex
DataFlex
Page Through All Contacts
See more Google APIs Examples
Demonstrates how to page through the entire list of Google Contacts.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoJsonToken
Variant vGAuth
Handle hoGAuth
Handle hoRest
Boolean iBAutoReconnect
Integer iStartIndex
Integer iMaxResults
Integer iTotalResults
Handle hoSbMaxResults
Handle hoSbStartIndex
Integer iLoopIteration
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoXml
Integer iStartIndex2
Integer iItemsPerPage
Integer iNumEntries
Integer i
String sIdUrl
String sFullName
String sEmailAddress
Variant vXLink
Handle hoXLink
Boolean iBHasPhoto
String sTemp1
Integer iTemp1
Boolean bTemp1
Move False To iSuccess
// 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
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/googleContacts.json" To iSuccess
If (iSuccess <> True) Begin
Showln "Failed to load googleContacts.json"
Procedure_Return
End
Get Create (RefClass(cComChilkatAuthGoogle)) To hoGAuth
If (Not(IsComObjectCreated(hoGAuth))) Begin
Send CreateComObject of hoGAuth
End
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Set ComAccessToken Of hoGAuth To sTemp1
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
// Connect using TLS.
Move True To iBAutoReconnect
Get ComConnect Of hoRest "www.google.com" 443 True iBAutoReconnect To iSuccess
// Provide the authentication credentials (i.e. the access token)
Get pvComObject of hoGAuth to vGAuth
Get ComSetAuthGoogle Of hoRest vGAuth To iSuccess
// ----------------------------------------------
// OK, the REST connection setup is completed..
// ----------------------------------------------
Move 1 To iStartIndex
Move 25 To iMaxResults
// The totalResults will get updated with the correct value in the 1st loop iteration..
Move 100 To iTotalResults
// 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
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbMaxResults
If (Not(IsComObjectCreated(hoSbMaxResults))) Begin
Send CreateComObject of hoSbMaxResults
End
Get ComAppendInt Of hoSbMaxResults iMaxResults To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbStartIndex
If (Not(IsComObjectCreated(hoSbStartIndex))) Begin
Send CreateComObject of hoSbStartIndex
End
Move 0 To iLoopIteration
While (iStartIndex <= iTotalResults)
Send ComClear To hoSbStartIndex
Get ComAppendInt Of hoSbStartIndex iStartIndex To iSuccess
Get ComClearAllHeaders Of hoRest To iSuccess
Get ComClearAllQueryParams Of hoRest To iSuccess
Get ComAddHeader Of hoRest "GData-Version" "3.0" To iSuccess
Get ComGetAsString Of hoSbStartIndex To sTemp1
Get ComAddQueryParam Of hoRest "start-index" sTemp1 To iSuccess
Get ComGetAsString Of hoSbMaxResults To sTemp1
Get ComAddQueryParam Of hoRest "max-results" sTemp1 To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestNoBodySb Of hoRest "GET" "/m8/feeds/contacts/default/full" vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// A successful response will have a status code equal to 200.
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 200) Begin
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "response status code = " iTemp1
Get ComResponseStatusText Of hoRest To sTemp1
Showln "response status text = " sTemp1
Get ComResponseHeader Of hoRest To sTemp1
Showln "response header: " sTemp1
Get ComGetAsString Of hoSbResponseBody To sTemp1
Showln "response body: " sTemp1
Procedure_Return
End
// If the 200 response was received, then the contacts XML is contained
// in the response body.
Get Create (RefClass(cComChilkatXml)) To hoXml
If (Not(IsComObjectCreated(hoXml))) Begin
Send CreateComObject of hoXml
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoXml vSbResponseBody False To iSuccess
// 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.
Get ComGetChildIntValue Of hoXml "openSearch:totalResults" To iTotalResults
Get ComGetChildIntValue Of hoXml "openSearch:startIndex" To iStartIndex2
Get ComGetChildIntValue Of hoXml "openSearch:itemsPerPage" To iItemsPerPage
Showln "totalResults = " iTotalResults
Showln "startIndex = " iStartIndex2
Showln "itemsPerPage = " iItemsPerPage
// Iterate over each contact.
Get ComNumChildrenHavingTag Of hoXml "entry" To iNumEntries
Move 0 To i
While (i < iNumEntries)
Set ComI Of hoXml To i
Showln (iLoopIteration * iMaxResults + i + 1) " ----"
Get ComGetChildContent Of hoXml "entry[i]|title" To sTemp1
Showln "title: " sTemp1
Get ComGetChildContent Of hoXml "entry[i]|id" To sIdUrl
Showln "id: " sIdUrl
Get ComChilkatPath Of hoXml "entry[i]|gd:name|gd:fullName|*" To sFullName
Get ComLastMethodSuccess Of hoXml To bTemp1
If (bTemp1 = True) Begin
Showln "fullName: " sFullName
End
Get ComChilkatPath Of hoXml "entry[i]|gd:email|(address)" To sEmailAddress
Get ComLastMethodSuccess Of hoXml To bTemp1
If (bTemp1 = True) Begin
Showln "email address: " sEmailAddress
End
// Find the photo link and check to see if this contact has a photo.
Get ComGetChildWithAttr Of hoXml "link" "rel" "http://schemas.google.com/contacts/2008/rel#photo" To vXLink
If (IsComObject(vXLink)) Begin
Get Create (RefClass(cComChilkatXml)) To hoXLink
Set pvComObject Of hoXLink To vXLink
End
Get ComLastMethodSuccess Of hoXml To bTemp1
If (bTemp1 = True) Begin
// Get the photo etag.
Get ComHasAttribute Of hoXLink "gd:etag" To iBHasPhoto
If (iBHasPhoto = True) Begin
Showln "This contact has a photo."
End
Send Destroy of hoXLink
End
Move (i + 1) To i
Loop
Move (iStartIndex + iMaxResults) To iStartIndex
Move (iLoopIteration + 1) To iLoopIteration
Loop
End_Procedure