| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <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> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an existing activity, if the access controls allow it.<br> |
| <br> |
| Args:<br> |
| activityId: string, ID of the activity to remove. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of activities.<br> |
| <br> |
| Args:<br> |
| pageToken: string, A continuation token that allows pagination.<br> |
| userId: string, The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). (required)<br> |
| maxResults: integer, The maximum number of activities to include in the response.<br> |
| collection: string, The collection of activities to list. (required)<br> |
| Allowed values<br> |
| all - All activities created by the specified user that the authenticated user is authorized to view.<br> |
| scraps - The specified user's scrapbook.<br> |
| stream - The specified user's stream feed, intended for consumption. This includes activities posted by people that the user is following, and activities in which the user has been mentioned.<br> |
| hl: string, Specifies the interface language (host language) of your user interface.<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "nextPageToken": "A String", # The value of pageToken query parameter in activities.list request to get the next page, if there are more to retrieve.<br> |
| "items": [ # List of activities retrieved.<br> |
| {<br> |
| "kind": "orkut#activity", # The kind of activity. Always orkut#activity.<br> |
| "links": [ # Links to resources related to this activity.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "title": "A String", # Title of the activity.<br> |
| "object": { # The activity's object.<br> |
| "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.<br> |
| "items": [ # The list of additional items.<br> |
| {<br> |
| "displayName": "A String", # The title of the object.<br> |
| "links": [ # Links to other resources related to this object.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "community": { # The community which is related with this activity, e.g. a joined community.<br> |
| "category": "A String", # The category of the community.<br> |
| "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"<br> |
| "member_count": 42, # The count of members on the community.<br> |
| "description": "A String", # The description of the community.<br> |
| "language": "A String", # The official language of the community.<br> |
| "links": [ # List of resources for the community.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "creation_date": "A String", # The time the community was created, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| "owner": { # The person who owns the community.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "moderators": [ # The moderator of the community.<br> |
| {<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| ],<br> |
| "location": "A String", # The location of the community.<br> |
| "co_owners": [ # The co-owners of the community.<br> |
| {<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| ],<br> |
| "photo_url": "A String", # The photo of the community.<br> |
| "id": 42, # The id of the community.<br> |
| "name": "A String", # The name of the community.<br> |
| },<br> |
| "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.<br> |
| "person": { # The person who is related with this activity, e.g. an Added User.<br> |
| "name": { # An object that encapsulates the individual components of a person's name.<br> |
| "givenName": "A String", # The given name (first name) of this person.<br> |
| "familyName": "A String", # The family name (last name) of this person.<br> |
| },<br> |
| "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br> |
| "gender": "A String", # The person's gender. Values include "male", "female", and "other".<br> |
| "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br> |
| "url": "A String", # The URL of the person's profile photo.<br> |
| },<br> |
| "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br> |
| "id": "A String", # The person's opensocial ID.<br> |
| },<br> |
| "id": "A String", # The ID for the object.<br> |
| "objectType": "A String", # The object type.<br> |
| },<br> |
| ],<br> |
| "replies": { # Comments in reply to this activity.<br> |
| "totalItems": "A String", # Total number of comments.<br> |
| "items": [ # The list of comments.<br> |
| {<br> |
| "inReplyTo": { # Link to the original activity where this comment was posted.<br> |
| "type": "A String", # Type of the post on activity stream being commented. Always text/html.<br> |
| "href": "A String", # Link to the post on activity stream being commented.<br> |
| "ref": "A String", # Unique identifier of the post on activity stream being commented.<br> |
| "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.<br> |
| },<br> |
| "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"<br> |
| "links": [ # List of resources for the comment.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "actor": { # The person who posted the comment.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "content": "A String", # The content of the comment in text/html<br> |
| "published": "A String", # The time the comment was initially published, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| "id": "A String", # The unique ID for the comment.<br> |
| },<br> |
| ],<br> |
| "url": "A String", # URL for the collection of comments in reply to this activity.<br> |
| },<br> |
| "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.<br> |
| },<br> |
| "updated": "A String", # The time at which the activity was last updated.<br> |
| "actor": { # The person who performed the activity.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "access": { # Identifies who has access to see this activity.<br> |
| "items": [ # The list of ACL entries.<br> |
| {<br> |
| "type": "A String", # The type of entity to whom access is granted.<br> |
| "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.<br> |
| },<br> |
| ],<br> |
| "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"<br> |
| "description": "A String", # Human readable description of the access granted.<br> |
| "totalParticipants": 42, # The total count of participants of the parent resource.<br> |
| },<br> |
| "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:<br> |
| # - add - User added new content to profile or album, e.g. video, photo.<br> |
| # - post - User publish content to the stream, e.g. status, scrap.<br> |
| # - update - User commented on an activity.<br> |
| # - make-friend - User added a new friend.<br> |
| # - birthday - User has a birthday.<br> |
| "published": "A String", # The time at which the activity was initially published.<br> |
| "id": "A String", # The ID for the activity.<br> |
| },<br> |
| ],<br> |
| "kind": "orkut#activityList", # Identifies this resource as a collection of activities. Value: "orkut#activityList"<br> |
| }</tt></dd></dl> |
| |
| <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> |
| <br> |
| Args:<br> |
| previous_request: The request for the previous page.<br> |
| previous_response: The response from the request for the previous page.<br> |
| <br> |
| Returns:<br> |
| A request object that you can call 'execute()' on to request the next<br> |
| page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |