Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f4839b0d74d8678a8e08964ce3e5899a77d8375f / . / docs / dyn / groupssettings_v1.groups.html
blob: b816e79fa93b556557bd9b753e9cd67ae83bc0b0 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="groupssettings_v1.html">Groups Settings API</a> . <a href="groupssettings_v1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(groupUniqueId)</a></code></p>
79<p class="firstline">Gets one resource by id.</p>
80<p class="toc_element">
81 <code><a href="#patch">patch(groupUniqueId, body)</a></code></p>
82<p class="firstline">Updates an existing resource. This method supports patch semantics.</p>
83<p class="toc_element">
84 <code><a href="#update">update(groupUniqueId, body)</a></code></p>
85<p class="firstline">Updates an existing resource.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(groupUniqueId)</code>
89 <pre>Gets one resource by id.
90
91Args:
92 groupUniqueId: string, The resource ID (required)
93
94Returns:
95 An object of the form:
96
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]97 { # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]98 "allowExternalMembers": "A String", # Are external members allowed to join the group.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]99 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]100 "primaryLanguage": "A String", # Primary language for the group.
101 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
102 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]103 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]104 "archiveOnly": "A String", # If the group is archive only
105 "isArchived": "A String", # If the contents of the group are archived.
106 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
107 "allowWebPosting": "A String", # If posting from web is allowed.
108 "email": "A String", # Email id of the group
109 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
110 "description": "A String", # Description of the group
111 "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
112 "customReplyTo": "A String", # Default email to which reply to any message should go.
113 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
114 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]115 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]116 "name": "A String", # Name of the Group
117 "kind": "groupsSettings#groups", # The type of the resource.
118 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]119 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]120 "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
121 "showInGroupDirectory": "A String", # Is the group listed in groups directory
122 "maxMessageBytes": 42, # Maximum message size allowed.
123 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
124 }</pre>
125</div>
126
127<div class="method">
128 <code class="details" id="patch">patch(groupUniqueId, body)</code>
129 <pre>Updates an existing resource. This method supports patch semantics.
130
131Args:
132 groupUniqueId: string, The resource ID (required)
133 body: object, The request body. (required)
134 The object takes the form of:
135
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]136{ # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]137 "allowExternalMembers": "A String", # Are external members allowed to join the group.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]138 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]139 "primaryLanguage": "A String", # Primary language for the group.
140 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
141 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]142 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]143 "archiveOnly": "A String", # If the group is archive only
144 "isArchived": "A String", # If the contents of the group are archived.
145 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
146 "allowWebPosting": "A String", # If posting from web is allowed.
147 "email": "A String", # Email id of the group
148 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
149 "description": "A String", # Description of the group
150 "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
151 "customReplyTo": "A String", # Default email to which reply to any message should go.
152 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
153 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]154 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]155 "name": "A String", # Name of the Group
156 "kind": "groupsSettings#groups", # The type of the resource.
157 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]158 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]159 "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
160 "showInGroupDirectory": "A String", # Is the group listed in groups directory
161 "maxMessageBytes": 42, # Maximum message size allowed.
162 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
163 }
164
165
166Returns:
167 An object of the form:
168
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]169 { # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]170 "allowExternalMembers": "A String", # Are external members allowed to join the group.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]171 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]172 "primaryLanguage": "A String", # Primary language for the group.
173 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
174 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]175 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]176 "archiveOnly": "A String", # If the group is archive only
177 "isArchived": "A String", # If the contents of the group are archived.
178 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
179 "allowWebPosting": "A String", # If posting from web is allowed.
180 "email": "A String", # Email id of the group
181 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
182 "description": "A String", # Description of the group
183 "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
184 "customReplyTo": "A String", # Default email to which reply to any message should go.
185 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
186 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]187 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]188 "name": "A String", # Name of the Group
189 "kind": "groupsSettings#groups", # The type of the resource.
190 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]191 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]192 "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
193 "showInGroupDirectory": "A String", # Is the group listed in groups directory
194 "maxMessageBytes": 42, # Maximum message size allowed.
195 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="update">update(groupUniqueId, body)</code>
201 <pre>Updates an existing resource.
202
203Args:
204 groupUniqueId: string, The resource ID (required)
205 body: object, The request body. (required)
206 The object takes the form of:
207
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]208{ # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]209 "allowExternalMembers": "A String", # Are external members allowed to join the group.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]210 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]211 "primaryLanguage": "A String", # Primary language for the group.
212 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
213 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]214 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]215 "archiveOnly": "A String", # If the group is archive only
216 "isArchived": "A String", # If the contents of the group are archived.
217 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
218 "allowWebPosting": "A String", # If posting from web is allowed.
219 "email": "A String", # Email id of the group
220 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
221 "description": "A String", # Description of the group
222 "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
223 "customReplyTo": "A String", # Default email to which reply to any message should go.
224 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
225 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]226 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]227 "name": "A String", # Name of the Group
228 "kind": "groupsSettings#groups", # The type of the resource.
229 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]230 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]231 "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
232 "showInGroupDirectory": "A String", # Is the group listed in groups directory
233 "maxMessageBytes": 42, # Maximum message size allowed.
234 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
235 }
236
237
238Returns:
239 An object of the form:
240
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]241 { # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]242 "allowExternalMembers": "A String", # Are external members allowed to join the group.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]243 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]244 "primaryLanguage": "A String", # Primary language for the group.
245 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
246 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]247 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]248 "archiveOnly": "A String", # If the group is archive only
249 "isArchived": "A String", # If the contents of the group are archived.
250 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
251 "allowWebPosting": "A String", # If posting from web is allowed.
252 "email": "A String", # Email id of the group
253 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
254 "description": "A String", # Description of the group
255 "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
256 "customReplyTo": "A String", # Default email to which reply to any message should go.
257 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
258 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]259 "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
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]260 "name": "A String", # Name of the Group
261 "kind": "groupsSettings#groups", # The type of the resource.
262 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]263 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]264 "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
265 "showInGroupDirectory": "A String", # Is the group listed in groups directory
266 "maxMessageBytes": 42, # Maximum message size allowed.
267 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
268 }</pre>
269</div>
270
271</body></html>