Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [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>Gets one resource by id.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | groupUniqueId: string, The resource ID (required)<br> |
| 21 | <br> |
| 22 | Returns:<br> |
| 23 | An object of the form<br> |
| 24 | <br> |
| 25 | { # Groups resource<br> |
| 26 | "allowExternalMembers": "A String", # Are external members allowed to join the group.<br> |
| 27 | "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN<br> |
| 28 | "primaryLanguage": "A String", # Primary language for the group.<br> |
| 29 | "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 30 | "defaultMessageDenyNotificationText": "A String", # Default message deny notification message<br> |
| 31 | "archiveOnly": "A String", # If the group is archive only<br> |
| 32 | "isArchived": "A String", # If the contents of the group are archived.<br> |
| 33 | "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.<br> |
| 34 | "allowWebPosting": "A String", # If posting from web is allowed.<br> |
| 35 | "email": "A String", # Email id of the group<br> |
| 36 | "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE<br> |
| 37 | "description": "A String", # Description of the group<br> |
| 38 | "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS<br> |
| 39 | "customReplyTo": "A String", # Default email to which reply to any message should go.<br> |
| 40 | "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.<br> |
| 41 | "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT<br> |
| 42 | "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST<br> |
| 43 | "name": "A String", # Name of the Group<br> |
| 44 | "kind": "groupsSettings#groups", # The type of the resource.<br> |
| 45 | "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE<br> |
| 46 | "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 47 | "showInGroupDirectory": "A String", # Is the group listed in groups directory<br> |
| 48 | "maxMessageBytes": 42, # Maximum message size allowed.<br> |
| 49 | "allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br> |
| 50 | }</tt></dd></dl> |
| 51 | |
| 52 | <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an existing resource. This method supports patch semantics.<br> |
| 53 | <br> |
| 54 | Args:<br> |
| 55 | body: object, The request body. (required)<br> |
| 56 | The object takes the form of:<br> |
| 57 | <br> |
| 58 | { # Groups resource<br> |
| 59 | "allowExternalMembers": "A String", # Are external members allowed to join the group.<br> |
| 60 | "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN<br> |
| 61 | "primaryLanguage": "A String", # Primary language for the group.<br> |
| 62 | "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 63 | "defaultMessageDenyNotificationText": "A String", # Default message deny notification message<br> |
| 64 | "archiveOnly": "A String", # If the group is archive only<br> |
| 65 | "isArchived": "A String", # If the contents of the group are archived.<br> |
| 66 | "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.<br> |
| 67 | "allowWebPosting": "A String", # If posting from web is allowed.<br> |
| 68 | "email": "A String", # Email id of the group<br> |
| 69 | "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE<br> |
| 70 | "description": "A String", # Description of the group<br> |
| 71 | "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS<br> |
| 72 | "customReplyTo": "A String", # Default email to which reply to any message should go.<br> |
| 73 | "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.<br> |
| 74 | "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT<br> |
| 75 | "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST<br> |
| 76 | "name": "A String", # Name of the Group<br> |
| 77 | "kind": "groupsSettings#groups", # The type of the resource.<br> |
| 78 | "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE<br> |
| 79 | "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 80 | "showInGroupDirectory": "A String", # Is the group listed in groups directory<br> |
| 81 | "maxMessageBytes": 42, # Maximum message size allowed.<br> |
| 82 | "allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br> |
| 83 | }<br> |
| 84 | <br> |
| 85 | groupUniqueId: string, The resource ID (required)<br> |
| 86 | <br> |
| 87 | Returns:<br> |
| 88 | An object of the form<br> |
| 89 | <br> |
| 90 | { # Groups resource<br> |
| 91 | "allowExternalMembers": "A String", # Are external members allowed to join the group.<br> |
| 92 | "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN<br> |
| 93 | "primaryLanguage": "A String", # Primary language for the group.<br> |
| 94 | "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 95 | "defaultMessageDenyNotificationText": "A String", # Default message deny notification message<br> |
| 96 | "archiveOnly": "A String", # If the group is archive only<br> |
| 97 | "isArchived": "A String", # If the contents of the group are archived.<br> |
| 98 | "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.<br> |
| 99 | "allowWebPosting": "A String", # If posting from web is allowed.<br> |
| 100 | "email": "A String", # Email id of the group<br> |
| 101 | "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE<br> |
| 102 | "description": "A String", # Description of the group<br> |
| 103 | "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS<br> |
| 104 | "customReplyTo": "A String", # Default email to which reply to any message should go.<br> |
| 105 | "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.<br> |
| 106 | "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT<br> |
| 107 | "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST<br> |
| 108 | "name": "A String", # Name of the Group<br> |
| 109 | "kind": "groupsSettings#groups", # The type of the resource.<br> |
| 110 | "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE<br> |
| 111 | "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 112 | "showInGroupDirectory": "A String", # Is the group listed in groups directory<br> |
| 113 | "maxMessageBytes": 42, # Maximum message size allowed.<br> |
| 114 | "allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br> |
| 115 | }</tt></dd></dl> |
| 116 | |
| 117 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an existing resource.<br> |
| 118 | <br> |
| 119 | Args:<br> |
| 120 | body: object, The request body. (required)<br> |
| 121 | The object takes the form of:<br> |
| 122 | <br> |
| 123 | { # Groups resource<br> |
| 124 | "allowExternalMembers": "A String", # Are external members allowed to join the group.<br> |
| 125 | "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN<br> |
| 126 | "primaryLanguage": "A String", # Primary language for the group.<br> |
| 127 | "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 128 | "defaultMessageDenyNotificationText": "A String", # Default message deny notification message<br> |
| 129 | "archiveOnly": "A String", # If the group is archive only<br> |
| 130 | "isArchived": "A String", # If the contents of the group are archived.<br> |
| 131 | "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.<br> |
| 132 | "allowWebPosting": "A String", # If posting from web is allowed.<br> |
| 133 | "email": "A String", # Email id of the group<br> |
| 134 | "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE<br> |
| 135 | "description": "A String", # Description of the group<br> |
| 136 | "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS<br> |
| 137 | "customReplyTo": "A String", # Default email to which reply to any message should go.<br> |
| 138 | "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.<br> |
| 139 | "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT<br> |
| 140 | "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST<br> |
| 141 | "name": "A String", # Name of the Group<br> |
| 142 | "kind": "groupsSettings#groups", # The type of the resource.<br> |
| 143 | "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE<br> |
| 144 | "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 145 | "showInGroupDirectory": "A String", # Is the group listed in groups directory<br> |
| 146 | "maxMessageBytes": 42, # Maximum message size allowed.<br> |
| 147 | "allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br> |
| 148 | }<br> |
| 149 | <br> |
| 150 | groupUniqueId: string, The resource ID (required)<br> |
| 151 | <br> |
| 152 | Returns:<br> |
| 153 | An object of the form<br> |
| 154 | <br> |
| 155 | { # Groups resource<br> |
| 156 | "allowExternalMembers": "A String", # Are external members allowed to join the group.<br> |
| 157 | "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN<br> |
| 158 | "primaryLanguage": "A String", # Primary language for the group.<br> |
| 159 | "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 160 | "defaultMessageDenyNotificationText": "A String", # Default message deny notification message<br> |
| 161 | "archiveOnly": "A String", # If the group is archive only<br> |
| 162 | "isArchived": "A String", # If the contents of the group are archived.<br> |
| 163 | "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.<br> |
| 164 | "allowWebPosting": "A String", # If posting from web is allowed.<br> |
| 165 | "email": "A String", # Email id of the group<br> |
| 166 | "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE<br> |
| 167 | "description": "A String", # Description of the group<br> |
| 168 | "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS<br> |
| 169 | "customReplyTo": "A String", # Default email to which reply to any message should go.<br> |
| 170 | "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.<br> |
| 171 | "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT<br> |
| 172 | "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST<br> |
| 173 | "name": "A String", # Name of the Group<br> |
| 174 | "kind": "groupsSettings#groups", # The type of the resource.<br> |
| 175 | "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE<br> |
| 176 | "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW<br> |
| 177 | "showInGroupDirectory": "A String", # Is the group listed in groups directory<br> |
| 178 | "maxMessageBytes": 42, # Maximum message size allowed.<br> |
| 179 | "allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br> |
| 180 | }</tt></dd></dl> |
| 181 | |
| 182 | <hr> |
| 183 | Data descriptors defined here:<br> |
| 184 | <dl><dt><strong>__dict__</strong></dt> |
| 185 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 186 | </dl> |
| 187 | <dl><dt><strong>__weakref__</strong></dt> |
| 188 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 189 | </dl> |
| 190 | </td></tr></table> |
| 191 | </body></html> |