Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / groupssettings_v1.groups.html
blob: 3965ca23efab9b617fa18923bd0da3b79ceafb84 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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
97 { # JSON template for Group resource
98 "allowExternalMembers": "A String", # Are external members allowed to join the group.
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
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
103 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
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 "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
115 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
116 "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
117 "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
118 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
119 "kind": "groupsSettings#groups", # The type of the resource.
120 "name": "A String", # Name of the Group
121 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
122 "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
123 "showInGroupDirectory": "A String", # Is the group listed in groups directory
124 "maxMessageBytes": 42, # Maximum message size allowed.
125 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="patch">patch(groupUniqueId, body)</code>
131 <pre>Updates an existing resource. This method supports patch semantics.
132
133Args:
134 groupUniqueId: string, The resource ID (required)
135 body: object, The request body. (required)
136 The object takes the form of:
137
138{ # JSON template for Group resource
139 "allowExternalMembers": "A String", # Are external members allowed to join the group.
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
141 "primaryLanguage": "A String", # Primary language for the group.
142 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
143 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
144 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
145 "archiveOnly": "A String", # If the group is archive only
146 "isArchived": "A String", # If the contents of the group are archived.
147 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
148 "allowWebPosting": "A String", # If posting from web is allowed.
149 "email": "A String", # Email id of the group
150 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
151 "description": "A String", # Description of the group
152 "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
153 "customReplyTo": "A String", # Default email to which reply to any message should go.
154 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
155 "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
156 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
157 "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
158 "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
159 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
160 "kind": "groupsSettings#groups", # The type of the resource.
161 "name": "A String", # Name of the Group
162 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
163 "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
164 "showInGroupDirectory": "A String", # Is the group listed in groups directory
165 "maxMessageBytes": 42, # Maximum message size allowed.
166 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
167 }
168
169
170Returns:
171 An object of the form:
172
173 { # JSON template for Group resource
174 "allowExternalMembers": "A String", # Are external members allowed to join the group.
175 "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
176 "primaryLanguage": "A String", # Primary language for the group.
177 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
178 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
179 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
180 "archiveOnly": "A String", # If the group is archive only
181 "isArchived": "A String", # If the contents of the group are archived.
182 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
183 "allowWebPosting": "A String", # If posting from web is allowed.
184 "email": "A String", # Email id of the group
185 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
186 "description": "A String", # Description of the group
187 "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
188 "customReplyTo": "A String", # Default email to which reply to any message should go.
189 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
190 "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
191 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
192 "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
193 "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
194 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
195 "kind": "groupsSettings#groups", # The type of the resource.
196 "name": "A String", # Name of the Group
197 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
198 "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
199 "showInGroupDirectory": "A String", # Is the group listed in groups directory
200 "maxMessageBytes": 42, # Maximum message size allowed.
201 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
202 }</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="update">update(groupUniqueId, body)</code>
207 <pre>Updates an existing resource.
208
209Args:
210 groupUniqueId: string, The resource ID (required)
211 body: object, The request body. (required)
212 The object takes the form of:
213
214{ # JSON template for Group resource
215 "allowExternalMembers": "A String", # Are external members allowed to join the group.
216 "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
217 "primaryLanguage": "A String", # Primary language for the group.
218 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
219 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
220 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
221 "archiveOnly": "A String", # If the group is archive only
222 "isArchived": "A String", # If the contents of the group are archived.
223 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
224 "allowWebPosting": "A String", # If posting from web is allowed.
225 "email": "A String", # Email id of the group
226 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
227 "description": "A String", # Description of the group
228 "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
229 "customReplyTo": "A String", # Default email to which reply to any message should go.
230 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
231 "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
232 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
233 "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
234 "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
235 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
236 "kind": "groupsSettings#groups", # The type of the resource.
237 "name": "A String", # Name of the Group
238 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
239 "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
240 "showInGroupDirectory": "A String", # Is the group listed in groups directory
241 "maxMessageBytes": 42, # Maximum message size allowed.
242 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
243 }
244
245
246Returns:
247 An object of the form:
248
249 { # JSON template for Group resource
250 "allowExternalMembers": "A String", # Are external members allowed to join the group.
251 "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
252 "primaryLanguage": "A String", # Primary language for the group.
253 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
254 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
255 "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
256 "archiveOnly": "A String", # If the group is archive only
257 "isArchived": "A String", # If the contents of the group are archived.
258 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
259 "allowWebPosting": "A String", # If posting from web is allowed.
260 "email": "A String", # Email id of the group
261 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
262 "description": "A String", # Description of the group
263 "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
264 "customReplyTo": "A String", # Default email to which reply to any message should go.
265 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
266 "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
267 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
268 "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
269 "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
270 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
271 "kind": "groupsSettings#groups", # The type of the resource.
272 "name": "A String", # Name of the Group
273 "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
274 "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
275 "showInGroupDirectory": "A String", # Is the group listed in groups directory
276 "maxMessageBytes": 42, # Maximum message size allowed.
277 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
278 }</pre>
279</div>
280
281</body></html>