Home | History | Annotate | Download | only in dyn 
      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="tasks_v1.html">Tasks API</a> . <a href="tasks_v1.tasklists.html">tasklists</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(tasklist)</a></code></p>
     79 <p class="firstline">Deletes the authenticated user's specified task list.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(tasklist)</a></code></p>
     82 <p class="firstline">Returns the authenticated user's specified task list.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(body)</a></code></p>
     85 <p class="firstline">Creates a new task list and adds it to the authenticated user's task lists.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
     88 <p class="firstline">Returns all the authenticated user's task lists.</p>
     89 <p class="toc_element">
     90   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     91 <p class="firstline">Retrieves the next page of results.</p>
     92 <p class="toc_element">
     93   <code><a href="#patch">patch(tasklist, body)</a></code></p>
     94 <p class="firstline">Updates the authenticated user's specified task list. This method supports patch semantics.</p>
     95 <p class="toc_element">
     96   <code><a href="#update">update(tasklist, body)</a></code></p>
     97 <p class="firstline">Updates the authenticated user's specified task list.</p>
     98 <h3>Method Details</h3>
     99 <div class="method">
    100     <code class="details" id="delete">delete(tasklist)</code>
    101   <pre>Deletes the authenticated user's specified task list.
    102 
    103 Args:
    104   tasklist: string, Task list identifier. (required)
    105 </pre>
    106 </div>
    107 
    108 <div class="method">
    109     <code class="details" id="get">get(tasklist)</code>
    110   <pre>Returns the authenticated user's specified task list.
    111 
    112 Args:
    113   tasklist: string, Task list identifier. (required)
    114 
    115 Returns:
    116   An object of the form:
    117 
    118     {
    119       "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    120       "etag": "A String", # ETag of the resource.
    121       "id": "A String", # Task list identifier.
    122       "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    123       "title": "A String", # Title of the task list.
    124     }</pre>
    125 </div>
    126 
    127 <div class="method">
    128     <code class="details" id="insert">insert(body)</code>
    129   <pre>Creates a new task list and adds it to the authenticated user's task lists.
    130 
    131 Args:
    132   body: object, The request body. (required)
    133     The object takes the form of:
    134 
    135 {
    136     "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    137     "etag": "A String", # ETag of the resource.
    138     "id": "A String", # Task list identifier.
    139     "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    140     "title": "A String", # Title of the task list.
    141   }
    142 
    143 
    144 Returns:
    145   An object of the form:
    146 
    147     {
    148       "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    149       "etag": "A String", # ETag of the resource.
    150       "id": "A String", # Task list identifier.
    151       "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    152       "title": "A String", # Title of the task list.
    153     }</pre>
    154 </div>
    155 
    156 <div class="method">
    157     <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
    158   <pre>Returns all the authenticated user's task lists.
    159 
    160 Args:
    161   pageToken: string, Token specifying the result page to return. Optional.
    162   maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
    163 
    164 Returns:
    165   An object of the form:
    166 
    167     {
    168     "nextPageToken": "A String", # Token that can be used to request the next page of this result.
    169     "items": [ # Collection of task lists.
    170       {
    171           "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    172           "etag": "A String", # ETag of the resource.
    173           "id": "A String", # Task list identifier.
    174           "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    175           "title": "A String", # Title of the task list.
    176         },
    177     ],
    178     "kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists".
    179     "etag": "A String", # ETag of the resource.
    180   }</pre>
    181 </div>
    182 
    183 <div class="method">
    184     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    185   <pre>Retrieves the next page of results.
    186 
    187 Args:
    188   previous_request: The request for the previous page. (required)
    189   previous_response: The response from the request for the previous page. (required)
    190 
    191 Returns:
    192   A request object that you can call 'execute()' on to request the next
    193   page. Returns None if there are no more items in the collection.
    194     </pre>
    195 </div>
    196 
    197 <div class="method">
    198     <code class="details" id="patch">patch(tasklist, body)</code>
    199   <pre>Updates the authenticated user's specified task list. This method supports patch semantics.
    200 
    201 Args:
    202   tasklist: string, Task list identifier. (required)
    203   body: object, The request body. (required)
    204     The object takes the form of:
    205 
    206 {
    207     "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    208     "etag": "A String", # ETag of the resource.
    209     "id": "A String", # Task list identifier.
    210     "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    211     "title": "A String", # Title of the task list.
    212   }
    213 
    214 
    215 Returns:
    216   An object of the form:
    217 
    218     {
    219       "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    220       "etag": "A String", # ETag of the resource.
    221       "id": "A String", # Task list identifier.
    222       "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    223       "title": "A String", # Title of the task list.
    224     }</pre>
    225 </div>
    226 
    227 <div class="method">
    228     <code class="details" id="update">update(tasklist, body)</code>
    229   <pre>Updates the authenticated user's specified task list.
    230 
    231 Args:
    232   tasklist: string, Task list identifier. (required)
    233   body: object, The request body. (required)
    234     The object takes the form of:
    235 
    236 {
    237     "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    238     "etag": "A String", # ETag of the resource.
    239     "id": "A String", # Task list identifier.
    240     "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    241     "title": "A String", # Title of the task list.
    242   }
    243 
    244 
    245 Returns:
    246   An object of the form:
    247 
    248     {
    249       "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
    250       "etag": "A String", # ETag of the resource.
    251       "id": "A String", # Task list identifier.
    252       "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
    253       "title": "A String", # Title of the task list.
    254     }</pre>
    255 </div>
    256 
    257 </body></html>