Groups Settings API v1

Version: 5.3

Groups Settings API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you manage permission levels and related settings of a group. Google documentation.

1 API Parameters

2 Resources

2.1 groups

(require gapi/macro)

(require-gapi-doc groupssettings.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 groups

procedure
(groupsSettings-groups-get #:groupUniqueId groupUniqueId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  groupUniqueId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets one resource by id.

groupUniqueId: The resource ID

procedure
(groupsSettings-groups-patch
#:groupUniqueId groupUniqueId
[ #:name name
#:description description
#:kind kind
#:email email
#:allowExternalMembers allowExternalMembers
#:allowGoogleCommunication allowGoogleCommunication
#:allowWebPosting allowWebPosting
#:archiveOnly archiveOnly
#:customReplyTo customReplyTo
#:defaultMessageDenyNotificationText defaultMessageDenyNotificationText
#:includeInGlobalAddressList includeInGlobalAddressList
#:isArchived isArchived
#:maxMessageBytes maxMessageBytes
#:membersCanPostAsTheGroup membersCanPostAsTheGroup
#:messageDisplayFont messageDisplayFont
#:messageModerationLevel messageModerationLevel
#:primaryLanguage primaryLanguage
#:replyTo replyTo
#:sendMessageDenyNotification sendMessageDenyNotification
#:showInGroupDirectory showInGroupDirectory
#:spamModerationLevel spamModerationLevel
#:whoCanInvite whoCanInvite
#:whoCanJoin whoCanJoin
#:whoCanPostMessage whoCanPostMessage
#:whoCanViewGroup whoCanViewGroup
#:whoCanViewMembership whoCanViewMembership
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  groupUniqueId : string?
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  email : string? = 'N/A
  allowExternalMembers : string? = 'N/A
  allowGoogleCommunication : string? = 'N/A
  allowWebPosting : string? = 'N/A
  archiveOnly : string? = 'N/A
  customReplyTo : string? = 'N/A
  defaultMessageDenyNotificationText : string? = 'N/A
  includeInGlobalAddressList : string? = 'N/A
  isArchived : string? = 'N/A
  maxMessageBytes : string? = 'N/A
  membersCanPostAsTheGroup : string? = 'N/A
  messageDisplayFont : string? = 'N/A
  messageModerationLevel : string? = 'N/A
  primaryLanguage : string? = 'N/A
  replyTo : string? = 'N/A
  sendMessageDenyNotification : string? = 'N/A
  showInGroupDirectory : string? = 'N/A
  spamModerationLevel : string? = 'N/A
  whoCanInvite : string? = 'N/A
  whoCanJoin : string? = 'N/A
  whoCanPostMessage : string? = 'N/A
  whoCanViewGroup : string? = 'N/A
  whoCanViewMembership : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates an existing resource. This method supports patch semantics.

groupUniqueId: The resource ID

name: Name of the Group

description: Description of the group

kind: The type of the resource.

email: Email id of the group

allowExternalMembers: Are external members allowed to join the group.

allowGoogleCommunication: Is google allowed to contact admins.

allowWebPosting: If posting from web is allowed.

archiveOnly: If the group is archive only

customReplyTo: Default email to which reply to any message should go.

defaultMessageDenyNotificationText: Default message deny notification message

includeInGlobalAddressList: If this groups should be included in global address list or not.

isArchived: If the contents of the group are archived.

maxMessageBytes: Maximum message size allowed.

membersCanPostAsTheGroup: Can members post using the group email address.

messageDisplayFont: Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT

messageModerationLevel: Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE

primaryLanguage: Primary language for the group.

replyTo: 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

sendMessageDenyNotification: Should the member be notified if his message is denied by owner.

showInGroupDirectory: Is the group listed in groups directory

spamModerationLevel: Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT

whoCanInvite: Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE

whoCanJoin: Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN

whoCanPostMessage: 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

whoCanViewGroup: Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW

whoCanViewMembership: Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW

procedure
(groupsSettings-groups-update
#:groupUniqueId groupUniqueId
[ #:name name
#:description description
#:kind kind
#:email email
#:allowExternalMembers allowExternalMembers
#:allowGoogleCommunication allowGoogleCommunication
#:allowWebPosting allowWebPosting
#:archiveOnly archiveOnly
#:customReplyTo customReplyTo
#:defaultMessageDenyNotificationText defaultMessageDenyNotificationText
#:includeInGlobalAddressList includeInGlobalAddressList
#:isArchived isArchived
#:maxMessageBytes maxMessageBytes
#:membersCanPostAsTheGroup membersCanPostAsTheGroup
#:messageDisplayFont messageDisplayFont
#:messageModerationLevel messageModerationLevel
#:primaryLanguage primaryLanguage
#:replyTo replyTo
#:sendMessageDenyNotification sendMessageDenyNotification
#:showInGroupDirectory showInGroupDirectory
#:spamModerationLevel spamModerationLevel
#:whoCanInvite whoCanInvite
#:whoCanJoin whoCanJoin
#:whoCanPostMessage whoCanPostMessage
#:whoCanViewGroup whoCanViewGroup
#:whoCanViewMembership whoCanViewMembership
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  groupUniqueId : string?
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  email : string? = 'N/A
  allowExternalMembers : string? = 'N/A
  allowGoogleCommunication : string? = 'N/A
  allowWebPosting : string? = 'N/A
  archiveOnly : string? = 'N/A
  customReplyTo : string? = 'N/A
  defaultMessageDenyNotificationText : string? = 'N/A
  includeInGlobalAddressList : string? = 'N/A
  isArchived : string? = 'N/A
  maxMessageBytes : string? = 'N/A
  membersCanPostAsTheGroup : string? = 'N/A
  messageDisplayFont : string? = 'N/A
  messageModerationLevel : string? = 'N/A
  primaryLanguage : string? = 'N/A
  replyTo : string? = 'N/A
  sendMessageDenyNotification : string? = 'N/A
  showInGroupDirectory : string? = 'N/A
  spamModerationLevel : string? = 'N/A
  whoCanInvite : string? = 'N/A
  whoCanJoin : string? = 'N/A
  whoCanPostMessage : string? = 'N/A
  whoCanViewGroup : string? = 'N/A
  whoCanViewMembership : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates an existing resource.