diff --git a/docs/dyn/books.v1.mylibrary.readingpositions.html b/docs/dyn/books.v1.mylibrary.readingpositions.html new file mode 100644 index 0000000..5014928 --- /dev/null +++ b/docs/dyn/books.v1.mylibrary.readingpositions.html @@ -0,0 +1,65 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Retrieves my reading position information for a volume.
+ 
+Args:
+  source: string, String to identify the originator of this request.
+  country: string, ISO-3166-1 code to override the IP-based location.
+  volumeId: string, Id of volume for which to retrieve a reading position. (required)
+  contentVersion: string, Volume content version for which this reading position is requested.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "books#readingPosition", # Resource type for a reading position.
+    "gbImagePosition": "A String", # Position in a volume for image-based content.
+    "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+    "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+    "volumeId": "A String", # Volume id associated with this reading position.
+    "pdfPosition": "A String", # Position in a PDF file.
+    "gbTextPosition": "A String", # Position in a volume for text-based content.
+  }
+ +
setPosition = method(self, **kwargs)
Sets my reading position information for a volume.
+ 
+Args:
+  source: string, String to identify the originator of this request.
+  volumeId: string, Id of volume for which to update the reading position. (required)
+  contentVersion: string, Volume content version for which this reading position applies.
+  country: string, ISO-3166-1 code to override the IP-based location.
+  position: string, Position string for the new volume reading position. (required)
+  timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
+  action: string, Action that caused this reading position to be set.
+    Allowed values
+      bookmark - User chose bookmark within volume.
+      chapter - User selected chapter from list.
+      next-page - Next page event.
+      prev-page - Previous page event.
+      scroll - User navigated to page.
+      search - User chose search results within volume.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/oauth2.v2.html b/docs/dyn/oauth2.v2.html new file mode 100644 index 0000000..8a9ce05 --- /dev/null +++ b/docs/dyn/oauth2.v2.html @@ -0,0 +1,48 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
tokeninfo = method(self, **kwargs)
A description of how to use this function
+ 
+Args:
+  access_token: string, A parameter
+  id_token: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
+    "user_id": "A String", # The Gaia obfuscated user id.
+    "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
+    "access_type": "A String", # The access type granted with this toke. It can be offline or online.
+    "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
+    "scope": "A String", # The space separated list of scopes granted to this token.
+    "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
+    "verified_email": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
+  }
+ +
userinfo = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/oauth2.v2.userinfo.html b/docs/dyn/oauth2.v2.userinfo.html new file mode 100644 index 0000000..a6bd5d5 --- /dev/null +++ b/docs/dyn/oauth2.v2.userinfo.html @@ -0,0 +1,50 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
A description of how to use this function
+ 
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "family_name": "A String",
+    "name": "A String",
+    "picture": "A String",
+    "locale": "A String",
+    "gender": "A String",
+    "email": "A String",
+    "birthday": "A String",
+    "link": "A String",
+    "given_name": "A String",
+    "timezone": "A String",
+    "id": "A String",
+    "verified_email": True or False,
+  }
+ +
v2 = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/oauth2.v2.userinfo.v2.html b/docs/dyn/oauth2.v2.userinfo.v2.html new file mode 100644 index 0000000..d478a78 --- /dev/null +++ b/docs/dyn/oauth2.v2.userinfo.v2.html @@ -0,0 +1,28 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
me = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/oauth2.v2.userinfo.v2.me.html b/docs/dyn/oauth2.v2.userinfo.v2.me.html new file mode 100644 index 0000000..ee10991 --- /dev/null +++ b/docs/dyn/oauth2.v2.userinfo.v2.me.html @@ -0,0 +1,48 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
A description of how to use this function
+ 
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "family_name": "A String",
+    "name": "A String",
+    "picture": "A String",
+    "locale": "A String",
+    "gender": "A String",
+    "email": "A String",
+    "birthday": "A String",
+    "link": "A String",
+    "given_name": "A String",
+    "timezone": "A String",
+    "id": "A String",
+    "verified_email": True or False,
+  }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communities.html b/docs/dyn/orkut.v2.communities.html new file mode 100644 index 0000000..ea1bf8a --- /dev/null +++ b/docs/dyn/orkut.v2.communities.html @@ -0,0 +1,152 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Retrieves the profile of a community.
+ 
+Args:
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "category": "A String", # The category of the community.
+    "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
+    "member_count": 42, # The count of members on the community.
+    "description": "A String", # The description of the community.
+    "language": "A String", # The official language of the community.
+    "links": [ # List of resources for the community.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "creation_date": "A String", # The time the community was created, in RFC 3339 format.
+    "owner": { # The person who owns the community.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "moderators": [ # The moderator of the community.
+      {
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+    ],
+    "location": "A String", # The location of the community.
+    "co_owners": [ # The co-owners of the community.
+      {
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+    ],
+    "photo_url": "A String", # The photo of the community.
+    "id": 42, # The id of the community.
+    "name": "A String", # The name of the community.
+  }
+ +
list = method(self, **kwargs)
Retrieves the communities an user is member of.
+ 
+Args:
+  orderBy: string, How to order the communities by.
+    Allowed values
+      id - Returns the communities sorted by a fixed, natural order.
+      ranked - Returns the communities ranked accordingly to how they are displayed on the orkut web application.
+  userId: string, The ID of the user whose communities will be listed. Can be me to refer to caller. (required)
+  maxResults: integer, The maximum number of communities to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # List of communities retrieved.
+      {
+        "category": "A String", # The category of the community.
+        "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
+        "member_count": 42, # The count of members on the community.
+        "description": "A String", # The description of the community.
+        "language": "A String", # The official language of the community.
+        "links": [ # List of resources for the community.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "creation_date": "A String", # The time the community was created, in RFC 3339 format.
+        "owner": { # The person who owns the community.
+          "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+          "image": { # Image data about the actor.
+            "url": "A String", # A URL that points to a thumbnail photo of the author.
+          },
+          "displayName": "A String", # The name of the author, suitable for display.
+          "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+        },
+        "moderators": [ # The moderator of the community.
+          {
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+        ],
+        "location": "A String", # The location of the community.
+        "co_owners": [ # The co-owners of the community.
+          {
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+        ],
+        "photo_url": "A String", # The photo of the community.
+        "id": 42, # The id of the community.
+        "name": "A String", # The name of the community.
+      },
+    ],
+    "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
+  }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityFollow.html b/docs/dyn/orkut.v2.communityFollow.html new file mode 100644 index 0000000..f89249a --- /dev/null +++ b/docs/dyn/orkut.v2.communityFollow.html @@ -0,0 +1,71 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
delete = method(self, **kwargs)
Removes an user from the followers of a community.
+ 
+Args:
+  userId: string, ID of the user. (required)
+  communityId: integer, ID of the community. (required)
+ +
insert = method(self, **kwargs)
Adds an user as a follower of a community.
+ 
+Args:
+  userId: string, ID of the user. (required)
+  communityId: integer, ID of the community. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "communityMembershipStatus": { # Status and permissions of the user related to the community.
+      "status": "A String", # The status of the current link between the community and the user.
+      "isFollowing": True or False, # Whether the user is following this community.
+      "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
+      "isModerator": True or False, # Whether the session user is a community moderator.
+      "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
+      "isCoOwner": True or False, # Whether the session user is a community co-owner.
+      "canCreatePoll": True or False, # Whether the user can create a poll in this community.
+      "canShout": True or False, # Whether the user can perform a shout operation in this community.
+      "isOwner": True or False, # Whether the session user is the community owner.
+      "canCreateTopic": True or False, # Whether the user can create a topic in this community.
+      "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
+    },
+    "person": { # Description of the community member.
+      "name": { # An object that encapsulates the individual components of a person's name.
+        "givenName": "A String", # The given name (first name) of this person.
+        "familyName": "A String", # The family name (last name) of this person.
+      },
+      "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+      "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+      "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+        "url": "A String", # The URL of the person's profile photo.
+      },
+      "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+      "id": "A String", # The person's opensocial ID.
+    },
+    "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
+  }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityMembers.html b/docs/dyn/orkut.v2.communityMembers.html new file mode 100644 index 0000000..7490ab5 --- /dev/null +++ b/docs/dyn/orkut.v2.communityMembers.html @@ -0,0 +1,172 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
delete = method(self, **kwargs)
Makes the user leave a community.
+ 
+Args:
+  userId: string, ID of the user. (required)
+  communityId: integer, ID of the community. (required)
+ +
get = method(self, **kwargs)
Retrieves the relationship between a user and a community.
+ 
+Args:
+  userId: string, ID of the user. (required)
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, ID of the community. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "communityMembershipStatus": { # Status and permissions of the user related to the community.
+      "status": "A String", # The status of the current link between the community and the user.
+      "isFollowing": True or False, # Whether the user is following this community.
+      "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
+      "isModerator": True or False, # Whether the session user is a community moderator.
+      "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
+      "isCoOwner": True or False, # Whether the session user is a community co-owner.
+      "canCreatePoll": True or False, # Whether the user can create a poll in this community.
+      "canShout": True or False, # Whether the user can perform a shout operation in this community.
+      "isOwner": True or False, # Whether the session user is the community owner.
+      "canCreateTopic": True or False, # Whether the user can create a topic in this community.
+      "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
+    },
+    "person": { # Description of the community member.
+      "name": { # An object that encapsulates the individual components of a person's name.
+        "givenName": "A String", # The given name (first name) of this person.
+        "familyName": "A String", # The family name (last name) of this person.
+      },
+      "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+      "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+      "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+        "url": "A String", # The URL of the person's profile photo.
+      },
+      "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+      "id": "A String", # The person's opensocial ID.
+    },
+    "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
+  }
+ +
insert = method(self, **kwargs)
Makes the user join a community.
+ 
+Args:
+  userId: string, ID of the user. (required)
+  communityId: integer, ID of the community. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "communityMembershipStatus": { # Status and permissions of the user related to the community.
+      "status": "A String", # The status of the current link between the community and the user.
+      "isFollowing": True or False, # Whether the user is following this community.
+      "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
+      "isModerator": True or False, # Whether the session user is a community moderator.
+      "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
+      "isCoOwner": True or False, # Whether the session user is a community co-owner.
+      "canCreatePoll": True or False, # Whether the user can create a poll in this community.
+      "canShout": True or False, # Whether the user can perform a shout operation in this community.
+      "isOwner": True or False, # Whether the session user is the community owner.
+      "canCreateTopic": True or False, # Whether the user can create a topic in this community.
+      "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
+    },
+    "person": { # Description of the community member.
+      "name": { # An object that encapsulates the individual components of a person's name.
+        "givenName": "A String", # The given name (first name) of this person.
+        "familyName": "A String", # The family name (last name) of this person.
+      },
+      "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+      "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+      "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+        "url": "A String", # The URL of the person's profile photo.
+      },
+      "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+      "id": "A String", # The person's opensocial ID.
+    },
+    "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
+  }
+ +
list = method(self, **kwargs)
Lists members of a community.
+ 
+Args:
+  friendsOnly: boolean, Whether to list only community members who are friends of the user.
+  pageToken: string, A continuation token that allows pagination.
+  maxResults: integer, The maximum number of members to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community whose members will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the next page, if there are more to retrieve.
+    "kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.
+    "items": [ # List of community members retrieved.
+      {
+        "communityMembershipStatus": { # Status and permissions of the user related to the community.
+          "status": "A String", # The status of the current link between the community and the user.
+          "isFollowing": True or False, # Whether the user is following this community.
+          "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
+          "isModerator": True or False, # Whether the session user is a community moderator.
+          "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
+          "isCoOwner": True or False, # Whether the session user is a community co-owner.
+          "canCreatePoll": True or False, # Whether the user can create a poll in this community.
+          "canShout": True or False, # Whether the user can perform a shout operation in this community.
+          "isOwner": True or False, # Whether the session user is the community owner.
+          "canCreateTopic": True or False, # Whether the user can create a topic in this community.
+          "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
+        },
+        "person": { # Description of the community member.
+          "name": { # An object that encapsulates the individual components of a person's name.
+            "givenName": "A String", # The given name (first name) of this person.
+            "familyName": "A String", # The family name (last name) of this person.
+          },
+          "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+          "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+          "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+            "url": "A String", # The URL of the person's profile photo.
+          },
+          "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+          "id": "A String", # The person's opensocial ID.
+        },
+        "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
+      },
+    ],
+    "prevPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the previous page, if there are more to retrieve.
+    "lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.
+    "firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityMessages.html b/docs/dyn/orkut.v2.communityMessages.html new file mode 100644 index 0000000..26f5549 --- /dev/null +++ b/docs/dyn/orkut.v2.communityMessages.html @@ -0,0 +1,151 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
delete = method(self, **kwargs)
Moves a message of the community to the trash folder.
+ 
+Args:
+  topicId: string, The ID of the topic whose message will be moved to the trash folder. (required)
+  messageId: string, The ID of the message to be moved to the trash folder. (required)
+  communityId: integer, The ID of the community whose message will be moved to the trash folder. (required)
+ +
insert = method(self, **kwargs)
Adds a message to a given community topic.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "body": "A String", # The body of the message.
+    "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+    "links": [ # List of resources for the community message.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "author": { # The creator of the message. If ommited, the message is annonimous.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "id": "A String", # The ID of the message.
+    "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+    "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+    "subject": "A String", # The subject of the message.
+  }
+ 
+  topicId: string, The ID of the topic the message should be added to. (required)
+  communityId: integer, The ID of the community the message should be added to. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "body": "A String", # The body of the message.
+      "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+      "links": [ # List of resources for the community message.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+      "author": { # The creator of the message. If ommited, the message is annonimous.
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+      "id": "A String", # The ID of the message.
+      "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+      "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+      "subject": "A String", # The subject of the message.
+    }
+ +
list = method(self, **kwargs)
Retrieves the messages of a topic of a community.
+ 
+Args:
+  topicId: string, The ID of the topic which messages will be listed. (required)
+  pageToken: string, A continuation token that allows pagination.
+  maxResults: integer, The maximum number of messages to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community which messages will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the next page, if there are more to retrieve.
+    "kind": "orkut#communityMessageList", # Identifies this resource as a collection of community messages. Value: "orkut#communityMessageList"
+    "items": [ # List of messages retrieved.
+      {
+          "body": "A String", # The body of the message.
+          "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+          "links": [ # List of resources for the community message.
+            { # Links to resources related to the parent object.
+              "href": "A String", # URL of the link.
+              "type": "A String", # Media type of the link.
+              "rel": "A String", # Relation between the resource and the parent object.
+              "title": "A String", # Title of the link.
+            },
+          ],
+          "author": { # The creator of the message. If ommited, the message is annonimous.
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+          "id": "A String", # The ID of the message.
+          "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+          "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+          "subject": "A String", # The subject of the message.
+        },
+    ],
+    "prevPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the previous page, if there are more to retrieve.
+    "lastPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the last page.
+    "firstPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the first page.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityPollComments.html b/docs/dyn/orkut.v2.communityPollComments.html new file mode 100644 index 0000000..d3ba6be --- /dev/null +++ b/docs/dyn/orkut.v2.communityPollComments.html @@ -0,0 +1,114 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
insert = method(self, **kwargs)
Adds a comment on a community poll.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "body": "A String", # The body of the message.
+    "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
+    "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
+    "id": 42, # The ID of the comment.
+    "author": { # The creator of the comment.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+  }
+ 
+  communityId: integer, The ID of the community whose poll is being commented. (required)
+  pollId: string, The ID of the poll being commented. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "body": "A String", # The body of the message.
+      "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
+      "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
+      "id": 42, # The ID of the comment.
+      "author": { # The creator of the comment.
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+    }
+ +
list = method(self, **kwargs)
Retrieves the comments of a community poll.
+ 
+Args:
+  pageToken: string, A continuation token that allows pagination.
+  maxResults: integer, The maximum number of comments to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community whose poll is having its comments listed. (required)
+  pollId: string, The ID of the community whose polls will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the next page, if there are more to retrieve.
+    "kind": "orkut#CommunityPollCommentList", # Identifies this resource as a collection of community poll comments. Value: "orkut#CommunityPollCommentList"
+    "items": [ # List of community poll comments retrieved.
+      {
+          "body": "A String", # The body of the message.
+          "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
+          "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
+          "id": 42, # The ID of the comment.
+          "author": { # The creator of the comment.
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+        },
+    ],
+    "prevPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the previous page, if there are more to retrieve.
+    "lastPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the last page.
+    "firstPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the first page.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityPollVotes.html b/docs/dyn/orkut.v2.communityPollVotes.html new file mode 100644 index 0000000..aead915 --- /dev/null +++ b/docs/dyn/orkut.v2.communityPollVotes.html @@ -0,0 +1,54 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
insert = method(self, **kwargs)
Votes on a community poll.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
+    "optionIds": [ # The ids of the voted options.
+      42,
+    ],
+    "isVotevisible": True or False, # Whether this vote is visible to other users or not.
+  }
+ 
+  communityId: integer, The ID of the community whose poll is being voted. (required)
+  pollId: string, The ID of the poll being voted. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
+      "optionIds": [ # The ids of the voted options.
+        42,
+      ],
+      "isVotevisible": True or False, # Whether this vote is visible to other users or not.
+    }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityPolls.html b/docs/dyn/orkut.v2.communityPolls.html new file mode 100644 index 0000000..2c8a37e --- /dev/null +++ b/docs/dyn/orkut.v2.communityPolls.html @@ -0,0 +1,170 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Retrieves one specific poll of a community.
+ 
+Args:
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community for whose poll will be retrieved. (required)
+  pollId: string, The ID of the poll to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "links": [ # List of resources for the community poll.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
+    "image": { # The image representing the poll. Field is omitted if no image exists.
+      "url": "A String", # A URL that points to an image of the poll.
+    },
+    "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
+    "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
+    "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
+    "totalNumberOfVotes": 42, # The total number of votes this poll has received.
+    "author": { # The person who created the poll.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "question": "A String", # The poll question.
+    "id": "A String", # The poll ID.
+    "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
+    "communityId": 42, # The ID of the community.
+    "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
+    "lastUpdate": "A String", # The date of the last update of this poll.
+    "description": "A String", # The poll description.
+    "votedOptions": [ # List of options the user has voted on, if there are any.
+      42,
+    ],
+    "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
+    "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
+    "hasVoted": True or False, # Whether the user has voted on this poll.
+    "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
+    "creationTime": "A String", # The date of creation of this poll
+    "options": [ # List of options of this poll.
+      {
+        "image": { # Image data about the poll option. Field is omitted if no image exists.
+          "url": "A String", # A URL that points to an image of the poll question.
+        },
+        "optionId": 42, # The poll option ID
+        "description": "A String", # The option description.
+        "numberOfVotes": 42, # The total number of votes that this option received.
+      },
+    ],
+  }
+ +
list = method(self, **kwargs)
Retrieves the polls of a community.
+ 
+Args:
+  pageToken: string, A continuation token that allows pagination.
+  maxResults: integer, The maximum number of polls to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community which polls will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the next page, if there are more to retrieve.
+    "kind": "orkut#communityPollList", # Identifies this resource as a collection of community polls. Value: "orkut#communityPollList"
+    "items": [ # List of community polls retrieved.
+      {
+        "links": [ # List of resources for the community poll.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
+        "image": { # The image representing the poll. Field is omitted if no image exists.
+          "url": "A String", # A URL that points to an image of the poll.
+        },
+        "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
+        "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
+        "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
+        "totalNumberOfVotes": 42, # The total number of votes this poll has received.
+        "author": { # The person who created the poll.
+          "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+          "image": { # Image data about the actor.
+            "url": "A String", # A URL that points to a thumbnail photo of the author.
+          },
+          "displayName": "A String", # The name of the author, suitable for display.
+          "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+        },
+        "question": "A String", # The poll question.
+        "id": "A String", # The poll ID.
+        "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
+        "communityId": 42, # The ID of the community.
+        "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
+        "lastUpdate": "A String", # The date of the last update of this poll.
+        "description": "A String", # The poll description.
+        "votedOptions": [ # List of options the user has voted on, if there are any.
+          42,
+        ],
+        "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
+        "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
+        "hasVoted": True or False, # Whether the user has voted on this poll.
+        "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
+        "creationTime": "A String", # The date of creation of this poll
+        "options": [ # List of options of this poll.
+          {
+            "image": { # Image data about the poll option. Field is omitted if no image exists.
+              "url": "A String", # A URL that points to an image of the poll question.
+            },
+            "optionId": 42, # The poll option ID
+            "description": "A String", # The option description.
+            "numberOfVotes": 42, # The total number of votes that this option received.
+          },
+        ],
+      },
+    ],
+    "prevPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the previous page, if there are more to retrieve.
+    "lastPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the last page.
+    "firstPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the first page.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityRelated.html b/docs/dyn/orkut.v2.communityRelated.html new file mode 100644 index 0000000..39a0412 --- /dev/null +++ b/docs/dyn/orkut.v2.communityRelated.html @@ -0,0 +1,89 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
list = method(self, **kwargs)
Retrieves the communities related to another one.
+ 
+Args:
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community whose related communities will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # List of communities retrieved.
+      {
+        "category": "A String", # The category of the community.
+        "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
+        "member_count": 42, # The count of members on the community.
+        "description": "A String", # The description of the community.
+        "language": "A String", # The official language of the community.
+        "links": [ # List of resources for the community.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "creation_date": "A String", # The time the community was created, in RFC 3339 format.
+        "owner": { # The person who owns the community.
+          "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+          "image": { # Image data about the actor.
+            "url": "A String", # A URL that points to a thumbnail photo of the author.
+          },
+          "displayName": "A String", # The name of the author, suitable for display.
+          "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+        },
+        "moderators": [ # The moderator of the community.
+          {
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+        ],
+        "location": "A String", # The location of the community.
+        "co_owners": [ # The co-owners of the community.
+          {
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+        ],
+        "photo_url": "A String", # The photo of the community.
+        "id": 42, # The id of the community.
+        "name": "A String", # The name of the community.
+      },
+    ],
+    "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
+  }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/orkut.v2.communityTopics.html b/docs/dyn/orkut.v2.communityTopics.html new file mode 100644 index 0000000..842d9dc --- /dev/null +++ b/docs/dyn/orkut.v2.communityTopics.html @@ -0,0 +1,296 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
delete = method(self, **kwargs)
Moves a topic of the community to the trash folder.
+ 
+Args:
+  topicId: string, The ID of the topic to be moved to the trash folder. (required)
+  communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)
+ +
get = method(self, **kwargs)
Retrieves a topic of a community.
+ 
+Args:
+  topicId: string, The ID of the topic to get. (required)
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community whose topic will be retrieved. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "body": "A String", # The body of the topic.
+      "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
+      "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
+      "links": [ # List of resources for the community.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+      "author": { # The creator of the topic.
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+      "title": "A String", # The title of the topic.
+      "messages": [ # Most recent messages.
+        {
+            "body": "A String", # The body of the message.
+            "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+            "links": [ # List of resources for the community message.
+              { # Links to resources related to the parent object.
+                "href": "A String", # URL of the link.
+                "type": "A String", # Media type of the link.
+                "rel": "A String", # Relation between the resource and the parent object.
+                "title": "A String", # Title of the link.
+              },
+            ],
+            "author": { # The creator of the message. If ommited, the message is annonimous.
+              "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+              "image": { # Image data about the actor.
+                "url": "A String", # A URL that points to a thumbnail photo of the author.
+              },
+              "displayName": "A String", # The name of the author, suitable for display.
+              "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+            },
+            "id": "A String", # The ID of the message.
+            "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+            "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+            "subject": "A String", # The subject of the message.
+          },
+      ],
+      "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
+      "isClosed": True or False, # Whether the topic is closed for new messages.
+      "numberOfReplies": 42, # The total number of replies this topic has received.
+      "id": "A String", # The ID of the topic.
+    }
+ +
insert = method(self, **kwargs)
Adds a topic to a given community.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "body": "A String", # The body of the topic.
+    "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
+    "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
+    "links": [ # List of resources for the community.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "author": { # The creator of the topic.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "title": "A String", # The title of the topic.
+    "messages": [ # Most recent messages.
+      {
+          "body": "A String", # The body of the message.
+          "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+          "links": [ # List of resources for the community message.
+            { # Links to resources related to the parent object.
+              "href": "A String", # URL of the link.
+              "type": "A String", # Media type of the link.
+              "rel": "A String", # Relation between the resource and the parent object.
+              "title": "A String", # Title of the link.
+            },
+          ],
+          "author": { # The creator of the message. If ommited, the message is annonimous.
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+          "id": "A String", # The ID of the message.
+          "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+          "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+          "subject": "A String", # The subject of the message.
+        },
+    ],
+    "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
+    "isClosed": True or False, # Whether the topic is closed for new messages.
+    "numberOfReplies": 42, # The total number of replies this topic has received.
+    "id": "A String", # The ID of the topic.
+  }
+ 
+  isShout: boolean, Whether this topic is a shout.
+  communityId: integer, The ID of the community the topic should be added to. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "body": "A String", # The body of the topic.
+      "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
+      "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
+      "links": [ # List of resources for the community.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+      "author": { # The creator of the topic.
+        "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+        "image": { # Image data about the actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the author.
+        },
+        "displayName": "A String", # The name of the author, suitable for display.
+        "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+      },
+      "title": "A String", # The title of the topic.
+      "messages": [ # Most recent messages.
+        {
+            "body": "A String", # The body of the message.
+            "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+            "links": [ # List of resources for the community message.
+              { # Links to resources related to the parent object.
+                "href": "A String", # URL of the link.
+                "type": "A String", # Media type of the link.
+                "rel": "A String", # Relation between the resource and the parent object.
+                "title": "A String", # Title of the link.
+              },
+            ],
+            "author": { # The creator of the message. If ommited, the message is annonimous.
+              "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+              "image": { # Image data about the actor.
+                "url": "A String", # A URL that points to a thumbnail photo of the author.
+              },
+              "displayName": "A String", # The name of the author, suitable for display.
+              "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+            },
+            "id": "A String", # The ID of the message.
+            "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+            "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+            "subject": "A String", # The subject of the message.
+          },
+      ],
+      "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
+      "isClosed": True or False, # Whether the topic is closed for new messages.
+      "numberOfReplies": 42, # The total number of replies this topic has received.
+      "id": "A String", # The ID of the topic.
+    }
+ +
list = method(self, **kwargs)
Retrieves the topics of a community.
+ 
+Args:
+  pageToken: string, A continuation token that allows pagination.
+  maxResults: integer, The maximum number of topics to include in the response.
+  hl: string, Specifies the interface language (host language) of your user interface.
+  communityId: integer, The ID of the community which topics will be listed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the next page, if there are more to retrieve.
+    "kind": "orkut#communityTopicList", # Identifies this resource as a collection of community topics. Value: "orkut#communityTopicList"
+    "items": [ # List of topics retrieved.
+      {
+          "body": "A String", # The body of the topic.
+          "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
+          "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
+          "links": [ # List of resources for the community.
+            { # Links to resources related to the parent object.
+              "href": "A String", # URL of the link.
+              "type": "A String", # Media type of the link.
+              "rel": "A String", # Relation between the resource and the parent object.
+              "title": "A String", # Title of the link.
+            },
+          ],
+          "author": { # The creator of the topic.
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+          "title": "A String", # The title of the topic.
+          "messages": [ # Most recent messages.
+            {
+                "body": "A String", # The body of the message.
+                "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
+                "links": [ # List of resources for the community message.
+                  { # Links to resources related to the parent object.
+                    "href": "A String", # URL of the link.
+                    "type": "A String", # Media type of the link.
+                    "rel": "A String", # Relation between the resource and the parent object.
+                    "title": "A String", # Title of the link.
+                  },
+                ],
+                "author": { # The creator of the message. If ommited, the message is annonimous.
+                  "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+                  "image": { # Image data about the actor.
+                    "url": "A String", # A URL that points to a thumbnail photo of the author.
+                  },
+                  "displayName": "A String", # The name of the author, suitable for display.
+                  "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+                },
+                "id": "A String", # The ID of the message.
+                "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
+                "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
+                "subject": "A String", # The subject of the message.
+              },
+          ],
+          "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
+          "isClosed": True or False, # Whether the topic is closed for new messages.
+          "numberOfReplies": 42, # The total number of replies this topic has received.
+          "id": "A String", # The ID of the topic.
+        },
+    ],
+    "prevPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the previous page, if there are more to retrieve.
+    "lastPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the last page.
+    "firstPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the first page.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/apiclient.anyjson.html b/docs/oauth2client.anyjson.html similarity index 80% rename from docs/apiclient.anyjson.html rename to docs/oauth2client.anyjson.html index aed7393..bc5d0ab 100644 --- a/docs/apiclient.anyjson.html +++ b/docs/oauth2client.anyjson.html @@ -1,14 +1,14 @@ -Python: module apiclient.anyjson +Python: module oauth2client.anyjson  
oauth2client.anyjson
 
- 
apiclient.anyjson		index
/home/jcgregorio/projects/apiclient-release/apiclient/anyjson.py
+>index
/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/anyjson.py

Utility module to import a JSON module
 
Hides all the messy details of exactly where
@@ -20,7 +20,7 @@ we get a simplejson module from.

Modules         -
simplejson
+
json