Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a comment.<br> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame^] | 20 | pp: string, A parameter<br> |
| 21 | trace: string, A parameter<br> |
| 22 | strict: string, A parameter<br> |
| 23 | userip: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 24 | commentId: string, The ID of the comment to get. (required)<br> |
| 25 | <br> |
| 26 | Returns:<br> |
| 27 | An object of the form<br> |
| 28 | <br> |
| 29 | {<br> |
| 30 | "inReplyTo": [ # The activity this comment replied to.<br> |
| 31 | {<br> |
| 32 | "url": "A String", # The url of the activity.<br> |
| 33 | "id": "A String", # The id of the activity.<br> |
| 34 | },<br> |
| 35 | ],<br> |
| 36 | "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".<br> |
| 37 | "object": { # The object of this comment.<br> |
| 38 | "content": "A String", # The content of this comment.<br> |
| 39 | "objectType": "comment", # The object type of this comment. Possible values are:<br> |
| 40 | # - "comment" - A comment in reply to an activity.<br> |
| 41 | },<br> |
| 42 | "updated": "A String", # The time at which this comment was last updated. Formatted as an <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp.<br> |
| 43 | "actor": { # The person who posted this comment.<br> |
| 44 | "url": "A String", # A link to the person resource for this actor.<br> |
| 45 | "image": { # The image representation of this actor.<br> |
| 46 | "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.<br> |
| 47 | },<br> |
| 48 | "displayName": "A String", # The name of this actor, suitable for display.<br> |
| 49 | "id": "A String", # The ID of the actor.<br> |
| 50 | },<br> |
| 51 | "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:<br> |
| 52 | # - "post" - Publish content to the stream.<br> |
Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 53 | "etag": "A String", # ETag of this response for caching purposes.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 54 | "published": "A String", # The time at which this comment was initially published. Formatted as an <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp.<br> |
| 55 | "id": "A String", # The ID of this comment.<br> |
| 56 | "selfLink": "A String", # Link to this comment resource.<br> |
| 57 | }</tt></dd></dl> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 58 | |
| 59 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all of the comments for an activity.<br> |
| 60 | <br> |
| 61 | Args:<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame^] | 62 | pp: string, A parameter<br> |
| 63 | trace: string, A parameter<br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 64 | pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.<br> |
| 65 | maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame^] | 66 | strict: string, A parameter<br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 67 | activityId: string, The ID of the activity to get comments for. (required)<br> |
Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 68 | sortOrder: string, The order in which to sort the list of comments.<br> |
| 69 | Allowed values<br> |
| 70 | ascending - Sort oldest comments first.<br> |
| 71 | descending - Sort newest comments first.<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame^] | 72 | userip: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 73 | <br> |
| 74 | Returns:<br> |
| 75 | An object of the form<br> |
| 76 | <br> |
| 77 | {<br> |
| 78 | "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.<br> |
| 79 | "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".<br> |
| 80 | "title": "A String", # The title of this collection of comments.<br> |
| 81 | "items": [ # The comments in this page of results.<br> |
| 82 | {<br> |
| 83 | "inReplyTo": [ # The activity this comment replied to.<br> |
| 84 | {<br> |
| 85 | "url": "A String", # The url of the activity.<br> |
| 86 | "id": "A String", # The id of the activity.<br> |
| 87 | },<br> |
| 88 | ],<br> |
| 89 | "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".<br> |
| 90 | "object": { # The object of this comment.<br> |
| 91 | "content": "A String", # The content of this comment.<br> |
| 92 | "objectType": "comment", # The object type of this comment. Possible values are:<br> |
| 93 | # - "comment" - A comment in reply to an activity.<br> |
| 94 | },<br> |
| 95 | "updated": "A String", # The time at which this comment was last updated. Formatted as an <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp.<br> |
| 96 | "actor": { # The person who posted this comment.<br> |
| 97 | "url": "A String", # A link to the person resource for this actor.<br> |
| 98 | "image": { # The image representation of this actor.<br> |
| 99 | "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.<br> |
| 100 | },<br> |
| 101 | "displayName": "A String", # The name of this actor, suitable for display.<br> |
| 102 | "id": "A String", # The ID of the actor.<br> |
| 103 | },<br> |
| 104 | "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:<br> |
| 105 | # - "post" - Publish content to the stream.<br> |
Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 106 | "etag": "A String", # ETag of this response for caching purposes.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 107 | "published": "A String", # The time at which this comment was initially published. Formatted as an <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp.<br> |
| 108 | "id": "A String", # The ID of this comment.<br> |
| 109 | "selfLink": "A String", # Link to this comment resource.<br> |
| 110 | },<br> |
| 111 | ],<br> |
| 112 | "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp.<br> |
| 113 | "nextLink": "A String", # Link to the next page of activities.<br> |
Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 114 | "etag": "A String", # ETag of this response for caching purposes.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 115 | "id": "A String", # The ID of this collection of comments.<br> |
| 116 | }</tt></dd></dl> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 117 | |
| 118 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 119 | <br> |
| 120 | Args:<br> |
| 121 | previous_request: The request for the previous page.<br> |
| 122 | previous_response: The response from the request for the previous page.<br> |
| 123 | <br> |
| 124 | Returns:<br> |
| 125 | A request object that you can call 'execute()' on to request the next<br> |
| 126 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 127 | |
| 128 | <hr> |
| 129 | Data descriptors defined here:<br> |
| 130 | <dl><dt><strong>__dict__</strong></dt> |
| 131 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 132 | </dl> |
| 133 | <dl><dt><strong>__weakref__</strong></dt> |
| 134 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 135 | </dl> |
| 136 | </td></tr></table> |
| 137 | </body></html> |