| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.settings.html">settings</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(setting)</a></code></p> |
| 79 | <p class="firstline">Returns a single user setting.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(maxResults=None, pageToken=None, syncToken=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Returns all user settings for the authenticated user.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Watch for changes to Settings resources.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="get">get(setting)</code> |
| 92 | <pre>Returns a single user setting. |
| 93 | |
| 94 | Args: |
| 95 | setting: string, The id of the user setting. (required) |
| 96 | |
| 97 | Returns: |
| 98 | An object of the form: |
| 99 | |
| 100 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "etag": "A String", # ETag of the resource. |
| 102 | "id": "A String", # The id of the user setting. |
| 103 | "kind": "calendar#setting", # Type of the resource ("calendar#setting"). |
| 104 | "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | }</pre> |
| 106 | </div> |
| 107 | |
| 108 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | <code class="details" id="list">list(maxResults=None, pageToken=None, syncToken=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 110 | <pre>Returns all user settings for the authenticated user. |
| 111 | |
| 112 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 113 | maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |
| 114 | pageToken: string, Token specifying which result page to return. Optional. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 115 | syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. |
| 116 | If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. |
| 117 | Learn more about incremental synchronization. |
| 118 | Optional. The default is to return all entries. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 119 | |
| 120 | Returns: |
| 121 | An object of the form: |
| 122 | |
| 123 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "etag": "A String", # Etag of the collection. |
| 125 | "items": [ # List of user settings. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 126 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 127 | "etag": "A String", # ETag of the resource. |
| 128 | "id": "A String", # The id of the user setting. |
| 129 | "kind": "calendar#setting", # Type of the resource ("calendar#setting"). |
| 130 | "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | }, |
| 132 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | "kind": "calendar#settings", # Type of the collection ("calendar#settings"). |
| 134 | "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. |
| 135 | "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | }</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 141 | <pre>Retrieves the next page of results. |
| 142 | |
| 143 | Args: |
| 144 | previous_request: The request for the previous page. (required) |
| 145 | previous_response: The response from the request for the previous page. (required) |
| 146 | |
| 147 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 149 | page. Returns None if there are no more items in the collection. |
| 150 | </pre> |
| 151 | </div> |
| 152 | |
| 153 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 154 | <code class="details" id="watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 155 | <pre>Watch for changes to Settings resources. |
| 156 | |
| 157 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 158 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 159 | The object takes the form of: |
| 160 | |
| 161 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "address": "A String", # The address where notifications are delivered for this channel. |
| 163 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 164 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 165 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 166 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 167 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 168 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 170 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 171 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 172 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 173 | "type": "A String", # The type of delivery mechanism used for this channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 174 | } |
| 175 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |
| 177 | pageToken: string, Token specifying which result page to return. Optional. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 178 | syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. |
| 179 | If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. |
| 180 | Learn more about incremental synchronization. |
| 181 | Optional. The default is to return all entries. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 182 | |
| 183 | Returns: |
| 184 | An object of the form: |
| 185 | |
| 186 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | "address": "A String", # The address where notifications are delivered for this channel. |
| 188 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 189 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 190 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 191 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 192 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 193 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 195 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 196 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 197 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 198 | "type": "A String", # The type of delivery mechanism used for this channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | }</pre> |
| 200 | </div> |
| 201 | |
| 202 | </body></html> |