Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ad8013f609a1d6034c23cf63dadc6a10f5883db6 / . / docs / dyn / groupssettings_v1.groups.html
blob: 483d2173cc3688193ea1428e60b26b96716491fc [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.
99 "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
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 "archiveOnly": "A String", # If the group is archive only
104 "isArchived": "A String", # If the contents of the group are archived.
105 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
106 "allowWebPosting": "A String", # If posting from web is allowed.
107 "email": "A String", # Email id of the group
108 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
109 "description": "A String", # Description of the group
110 "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
111 "customReplyTo": "A String", # Default email to which reply to any message should go.
112 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
113 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
114 "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
115 "name": "A String", # Name of the Group
116 "kind": "groupsSettings#groups", # The type of the resource.
117 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
118 "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
119 "showInGroupDirectory": "A String", # Is the group listed in groups directory
120 "maxMessageBytes": 42, # Maximum message size allowed.
121 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="patch">patch(groupUniqueId, body)</code>
127 <pre>Updates an existing resource. This method supports patch semantics.
128
129Args:
130 groupUniqueId: string, The resource ID (required)
131 body: object, The request body. (required)
132 The object takes the form of:
133
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame^]134{ # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]135 "allowExternalMembers": "A String", # Are external members allowed to join the group.
136 "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
137 "primaryLanguage": "A String", # Primary language for the group.
138 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
139 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
140 "archiveOnly": "A String", # If the group is archive only
141 "isArchived": "A String", # If the contents of the group are archived.
142 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
143 "allowWebPosting": "A String", # If posting from web is allowed.
144 "email": "A String", # Email id of the group
145 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
146 "description": "A String", # Description of the group
147 "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
148 "customReplyTo": "A String", # Default email to which reply to any message should go.
149 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
150 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
151 "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
152 "name": "A String", # Name of the Group
153 "kind": "groupsSettings#groups", # The type of the resource.
154 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
155 "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
156 "showInGroupDirectory": "A String", # Is the group listed in groups directory
157 "maxMessageBytes": 42, # Maximum message size allowed.
158 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
159 }
160
161
162Returns:
163 An object of the form:
164
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame^]165 { # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]166 "allowExternalMembers": "A String", # Are external members allowed to join the group.
167 "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
168 "primaryLanguage": "A String", # Primary language for the group.
169 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
170 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
171 "archiveOnly": "A String", # If the group is archive only
172 "isArchived": "A String", # If the contents of the group are archived.
173 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
174 "allowWebPosting": "A String", # If posting from web is allowed.
175 "email": "A String", # Email id of the group
176 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
177 "description": "A String", # Description of the group
178 "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
179 "customReplyTo": "A String", # Default email to which reply to any message should go.
180 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
181 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
182 "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
183 "name": "A String", # Name of the Group
184 "kind": "groupsSettings#groups", # The type of the resource.
185 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
186 "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
187 "showInGroupDirectory": "A String", # Is the group listed in groups directory
188 "maxMessageBytes": 42, # Maximum message size allowed.
189 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="update">update(groupUniqueId, body)</code>
195 <pre>Updates an existing resource.
196
197Args:
198 groupUniqueId: string, The resource ID (required)
199 body: object, The request body. (required)
200 The object takes the form of:
201
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame^]202{ # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]203 "allowExternalMembers": "A String", # Are external members allowed to join the group.
204 "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
205 "primaryLanguage": "A String", # Primary language for the group.
206 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
207 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
208 "archiveOnly": "A String", # If the group is archive only
209 "isArchived": "A String", # If the contents of the group are archived.
210 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
211 "allowWebPosting": "A String", # If posting from web is allowed.
212 "email": "A String", # Email id of the group
213 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
214 "description": "A String", # Description of the group
215 "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
216 "customReplyTo": "A String", # Default email to which reply to any message should go.
217 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
218 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
219 "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
220 "name": "A String", # Name of the Group
221 "kind": "groupsSettings#groups", # The type of the resource.
222 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
223 "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
224 "showInGroupDirectory": "A String", # Is the group listed in groups directory
225 "maxMessageBytes": 42, # Maximum message size allowed.
226 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
227 }
228
229
230Returns:
231 An object of the form:
232
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame^]233 { # JSON template for Group resource
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]234 "allowExternalMembers": "A String", # Are external members allowed to join the group.
235 "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
236 "primaryLanguage": "A String", # Primary language for the group.
237 "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
238 "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
239 "archiveOnly": "A String", # If the group is archive only
240 "isArchived": "A String", # If the contents of the group are archived.
241 "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
242 "allowWebPosting": "A String", # If posting from web is allowed.
243 "email": "A String", # Email id of the group
244 "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
245 "description": "A String", # Description of the group
246 "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
247 "customReplyTo": "A String", # Default email to which reply to any message should go.
248 "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
249 "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
250 "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
251 "name": "A String", # Name of the Group
252 "kind": "groupsSettings#groups", # The type of the resource.
253 "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
254 "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
255 "showInGroupDirectory": "A String", # Is the group listed in groups directory
256 "maxMessageBytes": 42, # Maximum message size allowed.
257 "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
258 }</pre>
259</div>
260
261</body></html>