(PureBasic) Page Through All Contacts

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

    ; 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

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleContacts.json")
    If success <> 1
        Debug "Failed to load googleContacts.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    gAuth.i = CkAuthGoogle::ckCreate()
    If gAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthGoogle::setCkAccessToken(gAuth, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect using TLS.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"www.google.com",443,1,bAutoReconnect)

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthGoogle(rest,gAuth)

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

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

    sbMaxResults.i = CkStringBuilder::ckCreate()
    If sbMaxResults.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppendInt(sbMaxResults,maxResults)
    sbStartIndex.i = CkStringBuilder::ckCreate()
    If sbStartIndex.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    loopIteration.i = 0
    While startIndex <= totalResults

        CkStringBuilder::ckClear(sbStartIndex)
        CkStringBuilder::ckAppendInt(sbStartIndex,startIndex)

        CkRest::ckClearAllHeaders(rest)
        CkRest::ckClearAllQueryParams(rest)
        CkRest::ckAddHeader(rest,"GData-Version","3.0")
        CkRest::ckAddQueryParam(rest,"start-index",CkStringBuilder::ckGetAsString(sbStartIndex))
        CkRest::ckAddQueryParam(rest,"max-results",CkStringBuilder::ckGetAsString(sbMaxResults))

        sbResponseBody.i = CkStringBuilder::ckCreate()
        If sbResponseBody.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        success = CkRest::ckFullRequestNoBodySb(rest,"GET","/m8/feeds/contacts/default/full",sbResponseBody)
        If success <> 1
            Debug CkRest::ckLastErrorText(rest)
            CkJsonObject::ckDispose(jsonToken)
            CkAuthGoogle::ckDispose(gAuth)
            CkRest::ckDispose(rest)
            CkStringBuilder::ckDispose(sbMaxResults)
            CkStringBuilder::ckDispose(sbStartIndex)
            CkStringBuilder::ckDispose(sbResponseBody)
            ProcedureReturn
        EndIf

        ; A successful response will have a status code equal to 200.
        If CkRest::ckResponseStatusCode(rest) <> 200
            Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
            Debug "response status text = " + CkRest::ckResponseStatusText(rest)
            Debug "response header: " + CkRest::ckResponseHeader(rest)
            Debug "response body: " + CkStringBuilder::ckGetAsString(sbResponseBody)
            CkJsonObject::ckDispose(jsonToken)
            CkAuthGoogle::ckDispose(gAuth)
            CkRest::ckDispose(rest)
            CkStringBuilder::ckDispose(sbMaxResults)
            CkStringBuilder::ckDispose(sbStartIndex)
            CkStringBuilder::ckDispose(sbResponseBody)
            ProcedureReturn
        EndIf

        ; If the 200 response was received, then the contacts XML is contained
        ; in the response body.
        xml.i = CkXml::ckCreate()
        If xml.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkXml::ckLoadSb(xml,sbResponseBody,0)

        ; 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 = CkXml::ckGetChildIntValue(xml,"openSearch:totalResults")
        startIndex2.i = CkXml::ckGetChildIntValue(xml,"openSearch:startIndex")
        itemsPerPage.i = CkXml::ckGetChildIntValue(xml,"openSearch:itemsPerPage")
        Debug "totalResults = " + Str(totalResults)
        Debug "startIndex = " + Str(startIndex2)
        Debug "itemsPerPage = " + Str(itemsPerPage)

        ; Iterate over each contact.
        numEntries.i = CkXml::ckNumChildrenHavingTag(xml,"entry")
        i.i = 0
        While i < numEntries
            CkXml::setCkI(xml, i)
            Debug Str(loopIteration * maxResults + i + 1) + " ----"
            Debug "title: " + CkXml::ckGetChildContent(xml,"entry[i]|title")

            idUrl.s = CkXml::ckGetChildContent(xml,"entry[i]|id")
            Debug "id: " + idUrl

            fullName.s = CkXml::ckChilkatPath(xml,"entry[i]|gd:name|gd:fullName|*")
            If CkXml::ckLastMethodSuccess(xml) = 1
                Debug "fullName: " + fullName
            EndIf

            emailAddress.s = CkXml::ckChilkatPath(xml,"entry[i]|gd:email|(address)")
            If CkXml::ckLastMethodSuccess(xml) = 1
                Debug "email address: " + emailAddress
            EndIf

            ; Find the photo link and check to see if this contact has a photo.
            xLink.i = CkXml::ckGetChildWithAttr(xml,"link","rel","http://schemas.google.com/contacts/2008/rel#photo")
            If CkXml::ckLastMethodSuccess(xml) = 1
                ; Get the photo etag.
                bHasPhoto.i = CkXml::ckHasAttribute(xLink,"gd:etag")
                If bHasPhoto = 1
                    Debug "This contact has a photo."
                EndIf

                CkXml::ckDispose(xLink)

            EndIf

            i = i + 1
        Wend

        startIndex = startIndex + maxResults
        loopIteration = loopIteration + 1
    Wend


    CkJsonObject::ckDispose(jsonToken)
    CkAuthGoogle::ckDispose(gAuth)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbMaxResults)
    CkStringBuilder::ckDispose(sbStartIndex)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure