(Tcl) Google Calendar Search Events (List Events with Optional Query Parameters)

See more Google Calendar Examples

Demonstrates how to specify optional query parameters for listing events. This example uses the "q" parameter to free-text search for events, and uses the "timeMin" parameter to specify a lower bound for an event's end time.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# This example uses a previously obtained access token having permission for the 
# Google Calendar scope.

# In this example, Get Google Calendar OAuth2 Access Token, the access
# token was saved to a JSON file.  This example fetches the access token from the file..
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/googleCalendar.json"]
if {[CkJsonObject_HasMember $jsonToken "access_token"] == 0} then {
    puts "No access token found."
    delete_CkJsonObject $jsonToken
    exit
}

set http [new_CkHttp]

CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

# We'll want to build a URL with the query params..
set sbUrl [new_CkStringBuilder]

CkStringBuilder_Append $sbUrl "https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?"

# Use the HTTP request object as a helper for creating the URL encoded query param list..
set req [new_CkHttpRequest]

# Find events with the word "pizza".
CkHttpRequest_AddParam $req "q" "pizza"

# Get events for the current date/time or later.
set dt [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dt
CkHttpRequest_AddParam $req "timeMin" [CkDateTime_getAsTimestamp $dt 0]

# Add these query params to the URL:
CkStringBuilder_Append $sbUrl [CkHttpRequest_getUrlEncodedParams $req]

# Examine the URL..
puts "URL: [CkStringBuilder_getAsString $sbUrl]"

# The URL looks like this:
# https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?q=pizza&timeMin=2017-08-11T13%3A35%3A28Z

# Let's get events in the primary calendar.  A calendar ID could have be used instead of "primary".
CkHttp_SetUrlVar $http "calendarId" "primary"
set sbResponse [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http [CkStringBuilder_getAsString $sbUrl] $sbResponse]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkJsonObject $jsonToken
    delete_CkHttp $http
    delete_CkStringBuilder $sbUrl
    delete_CkHttpRequest $req
    delete_CkDateTime $dt
    delete_CkStringBuilder $sbResponse
    exit
}

if {[CkHttp_get_LastStatus $http] != 200} then {
    # Note: If a 401 unauthorized response is received, it likely means that the OAuth2 access token needs
    # to be refreshed or re-fetched.
    puts "Error response status: [CkHttp_get_LastStatus $http]"
    puts [CkStringBuilder_getAsString $sbResponse]
    delete_CkJsonObject $jsonToken
    delete_CkHttp $http
    delete_CkStringBuilder $sbUrl
    delete_CkHttpRequest $req
    delete_CkDateTime $dt
    delete_CkStringBuilder $sbResponse
    exit
}

puts [CkStringBuilder_getAsString $sbResponse]

# A sample JSON response:
# (Code for parsing the Google Calendar events is shown below.)

# {
#  "kind": "calendar#events",
#  "etag": "\"p32cafkumkb7ta0g\"",
#  "summary": "support@chilkatcloud.com",
#  "updated": "2017-08-11T13:19:48.143Z",
#  "timeZone": "America/Chicago",
#  "accessRole": "owner",
#  "defaultReminders": [
#   {
#    "method": "popup",
#    "minutes": 10
#   }
#  ],
#  "nextSyncToken": "CJin09aiz9UCEJin09aiz9UCGAU=",
#  "items": [
#   {
#    "kind": "calendar#event",
#    "etag": "\"3004915160212000\"",
#    "id": "02pv1cpdp7vm11htnfi3ii7iie",
#    "status": "confirmed",
#    "htmlLink": "https://www.google.com/calendar/event?eid=MDJwdjFjcGRwN3ZtMTFodG5maTNpaTdpaWUgc3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t",
#    "created": "2017-08-11T13:19:40.000Z",
#    "updated": "2017-08-11T13:19:40.106Z",
#    "summary": "Eat Lou Malnati's Pizza",
#    "creator": {
#     "email": "support@chilkatcloud.com",
#     "self": true
#    },
#    "organizer": {
#     "email": "support@chilkatcloud.com",
#     "self": true
#    },
#    "start": {
#     "dateTime": "2017-08-12T12:00:00-05:00"
#    },
#    "end": {
#     "dateTime": "2017-08-12T13:00:00-05:00"
#    },
#    "iCalUID": "02pv1cpdp7vm11htnfi3ii7iie@google.com",
#    "sequence": 0,
#    "hangoutLink": "https://plus.google.com/hangouts/_/chilkatcloud.com/support?hceid=c3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t.02pv1cpdp7vm11htnfi3ii7iie",
#    "reminders": {
#     "useDefault": true
#    }
#   }
#  ]
# }
# 
# 

set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbResponse

set numEvents [CkJsonObject_SizeOfArray $json "items"]
set i 0
while {$i < $numEvents} {
    CkJsonObject_put_I $json $i
    puts [CkJsonObject_stringOf $json {items[i].summary}]
    puts [CkJsonObject_stringOf $json {items[i].start.dateTime}]
    puts [CkJsonObject_stringOf $json {items[i].end.dateTime}]
    puts "--"
    set i [expr $i + 1]
}

# Sample output:

# Eat Lou Malnati's Pizza
# 2017-08-12T12:00:00-05:00
# 2017-08-12T13:00:00-05:00
# --

delete_CkJsonObject $jsonToken
delete_CkHttp $http
delete_CkStringBuilder $sbUrl
delete_CkHttpRequest $req
delete_CkDateTime $dt
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $json