groupssettings

Documentation

Overview

Package groupssettings provides access to the Groups Settings API.

See https://developers.google.com/google-apps/groups-settings/get_started

Usage example:

import "google.golang.org/api/groupssettings/v1"
...
groupssettingsService, err := groupssettings.New(oauthHttpClient)

Index

• Constants
• type Groups
  • func (s *Groups) MarshalJSON() ([]byte, error)
• type GroupsGetCall
  • func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall
  • func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Groups, error)
  • func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall
  • func (c *GroupsGetCall) Header() http.Header
  • func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall
• type GroupsPatchCall
  • func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall
  • func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Groups, error)
  • func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall
  • func (c *GroupsPatchCall) Header() http.Header
• type GroupsService
  • func NewGroupsService(s *Service) *GroupsService
  • func (r *GroupsService) Get(groupUniqueId string) *GroupsGetCall
  • func (r *GroupsService) Patch(groupUniqueId string, groups *Groups) *GroupsPatchCall
  • func (r *GroupsService) Update(groupUniqueId string, groups *Groups) *GroupsUpdateCall
• type GroupsUpdateCall
  • func (c *GroupsUpdateCall) Context(ctx context.Context) *GroupsUpdateCall
  • func (c *GroupsUpdateCall) Do(opts ...googleapi.CallOption) (*Groups, error)
  • func (c *GroupsUpdateCall) Fields(s ...googleapi.Field) *GroupsUpdateCall
  • func (c *GroupsUpdateCall) Header() http.Header
• type Service
  • func New(client *http.Client) (*Service, error)

Constants

const (
	// View and manage the settings of a G Suite group
	AppsGroupsSettingsScope = "https://www.googleapis.com/auth/apps.groups.settings"
)

OAuth2 scopes used by this API.

Types

type Groups

type Groups struct {
	// AllowExternalMembers: Are external members allowed to join the group.
	AllowExternalMembers string `json:"allowExternalMembers,omitempty"`

	// AllowGoogleCommunication: Is google allowed to contact admins.
	AllowGoogleCommunication string `json:"allowGoogleCommunication,omitempty"`

	// AllowWebPosting: If posting from web is allowed.
	AllowWebPosting string `json:"allowWebPosting,omitempty"`

	// ArchiveOnly: If the group is archive only
	ArchiveOnly string `json:"archiveOnly,omitempty"`

	// CustomFooterText: Custom footer text.
	CustomFooterText string `json:"customFooterText,omitempty"`

	// CustomReplyTo: Default email to which reply to any message should go.
	CustomReplyTo string `json:"customReplyTo,omitempty"`

	// DefaultMessageDenyNotificationText: Default message deny notification
	// message
	DefaultMessageDenyNotificationText string `json:"defaultMessageDenyNotificationText,omitempty"`

	// Description: Description of the group
	Description string `json:"description,omitempty"`

	// Email: Email id of the group
	Email string `json:"email,omitempty"`

	// FavoriteRepliesOnTop: If favorite replies should be displayed above
	// other replies.
	FavoriteRepliesOnTop string `json:"favoriteRepliesOnTop,omitempty"`

	// IncludeCustomFooter: Whether to include custom footer.
	IncludeCustomFooter string `json:"includeCustomFooter,omitempty"`

	// IncludeInGlobalAddressList: If this groups should be included in
	// global address list or not.
	IncludeInGlobalAddressList string `json:"includeInGlobalAddressList,omitempty"`

	// IsArchived: If the contents of the group are archived.
	IsArchived string `json:"isArchived,omitempty"`

	// Kind: The type of the resource.
	Kind string `json:"kind,omitempty"`

	// MaxMessageBytes: Maximum message size allowed.
	MaxMessageBytes int64 `json:"maxMessageBytes,omitempty"`

	// MembersCanPostAsTheGroup: Can members post using the group email
	// address.
	MembersCanPostAsTheGroup string `json:"membersCanPostAsTheGroup,omitempty"`

	// MessageDisplayFont: Default message display font. Possible values
	// are: DEFAULT_FONT FIXED_WIDTH_FONT
	MessageDisplayFont string `json:"messageDisplayFont,omitempty"`

	// MessageModerationLevel: Moderation level for messages. Possible
	// values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS
	// MODERATE_NEW_MEMBERS MODERATE_NONE
	MessageModerationLevel string `json:"messageModerationLevel,omitempty"`

	// Name: Name of the Group
	Name string `json:"name,omitempty"`

	// PrimaryLanguage: Primary language for the group.
	PrimaryLanguage string `json:"primaryLanguage,omitempty"`

	// 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
	ReplyTo string `json:"replyTo,omitempty"`

	// SendMessageDenyNotification: Should the member be notified if his
	// message is denied by owner.
	SendMessageDenyNotification string `json:"sendMessageDenyNotification,omitempty"`

	// ShowInGroupDirectory: Is the group listed in groups directory
	ShowInGroupDirectory string `json:"showInGroupDirectory,omitempty"`

	// SpamModerationLevel: Moderation level for messages detected as spam.
	// Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
	SpamModerationLevel string `json:"spamModerationLevel,omitempty"`

	// WhoCanAdd: Permissions to add members. Possible values are:
	// ALL_MANAGERS_CAN_ADD ALL_OWNERS_CAN_ADD ALL_MEMBERS_CAN_ADD
	// NONE_CAN_ADD
	WhoCanAdd string `json:"whoCanAdd,omitempty"`

	// WhoCanAddReferences: Permission to add references to a topic.
	// Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanAddReferences string `json:"whoCanAddReferences,omitempty"`

	// WhoCanAssignTopics: Permission to assign topics in a forum to another
	// user. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanAssignTopics string `json:"whoCanAssignTopics,omitempty"`

	// WhoCanContactOwner: Permission to contact owner of the group via web
	// UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT
	// ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
	WhoCanContactOwner string `json:"whoCanContactOwner,omitempty"`

	// WhoCanEnterFreeFormTags: Permission to enter free form tags for
	// topics in a forum. Possible values are: NONE OWNERS_ONLY
	// MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanEnterFreeFormTags string `json:"whoCanEnterFreeFormTags,omitempty"`

	// WhoCanInvite: Permissions to invite members. Possible values are:
	// ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE ALL_OWNERS_CAN_INVITE
	// NONE_CAN_INVITE
	WhoCanInvite string `json:"whoCanInvite,omitempty"`

	// WhoCanJoin: Permissions to join the group. Possible values are:
	// ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN
	// CAN_REQUEST_TO_JOIN
	WhoCanJoin string `json:"whoCanJoin,omitempty"`

	// WhoCanLeaveGroup: Permission to leave the group. Possible values are:
	// ALL_MANAGERS_CAN_LEAVE ALL_OWNERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
	// NONE_CAN_LEAVE
	WhoCanLeaveGroup string `json:"whoCanLeaveGroup,omitempty"`

	// WhoCanMarkDuplicate: Permission to mark a topic as a duplicate of
	// another topic. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanMarkDuplicate string `json:"whoCanMarkDuplicate,omitempty"`

	// WhoCanMarkFavoriteReplyOnAnyTopic: Permission to mark any other
	// user's post as a favorite reply. Possible values are: NONE
	// OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanMarkFavoriteReplyOnAnyTopic string `json:"whoCanMarkFavoriteReplyOnAnyTopic,omitempty"`

	// WhoCanMarkFavoriteReplyOnOwnTopic: Permission to mark a post for a
	// topic they started as a favorite reply. Possible values are: NONE
	// OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanMarkFavoriteReplyOnOwnTopic string `json:"whoCanMarkFavoriteReplyOnOwnTopic,omitempty"`

	// WhoCanMarkNoResponseNeeded: Permission to mark a topic as not needing
	// a response. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanMarkNoResponseNeeded string `json:"whoCanMarkNoResponseNeeded,omitempty"`

	// WhoCanModifyTagsAndCategories: Permission to change tags and
	// categories. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanModifyTagsAndCategories string `json:"whoCanModifyTagsAndCategories,omitempty"`

	// WhoCanPostMessage: Permissions to post messages to the group.
	// Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST
	// ALL_MEMBERS_CAN_POST ALL_OWNERS_CAN_POST ALL_IN_DOMAIN_CAN_POST
	// ANYONE_CAN_POST
	WhoCanPostMessage string `json:"whoCanPostMessage,omitempty"`

	// WhoCanTakeTopics: Permission to take topics in a forum. Possible
	// values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS
	// ALL_MEMBERS
	WhoCanTakeTopics string `json:"whoCanTakeTopics,omitempty"`

	// WhoCanUnassignTopic: Permission to unassign any topic in a forum.
	// Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
	// OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanUnassignTopic string `json:"whoCanUnassignTopic,omitempty"`

	// WhoCanUnmarkFavoriteReplyOnAnyTopic: Permission to unmark any post
	// from a favorite reply. Possible values are: NONE OWNERS_ONLY
	// MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
	WhoCanUnmarkFavoriteReplyOnAnyTopic string `json:"whoCanUnmarkFavoriteReplyOnAnyTopic,omitempty"`

	// WhoCanViewGroup: Permissions to view group. Possible values are:
	// ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW
	// ALL_MANAGERS_CAN_VIEW ALL_OWNERS_CAN_VIEW
	WhoCanViewGroup string `json:"whoCanViewGroup,omitempty"`

	// WhoCanViewMembership: Permissions to view membership. Possible values
	// are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW
	// ALL_MANAGERS_CAN_VIEW
	WhoCanViewMembership string `json:"whoCanViewMembership,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "AllowExternalMembers") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowExternalMembers") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Groups: JSON template for Group resource

func (*Groups) MarshalJSON

func (s *Groups) MarshalJSON() ([]byte, error)

type GroupsGetCall

type GroupsGetCall struct {
	// contains filtered or unexported fields
}

func (*GroupsGetCall) Context

func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsGetCall) Do

func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Groups, error)

Do executes the "groupsSettings.groups.get" call. Exactly one of *Groups or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Groups.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsGetCall) Fields

func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsGetCall) Header

func (c *GroupsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsGetCall) IfNoneMatch

func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsPatchCall

type GroupsPatchCall struct {
	// contains filtered or unexported fields
}

func (*GroupsPatchCall) Context

func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsPatchCall) Do

func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Groups, error)

Do executes the "groupsSettings.groups.patch" call. Exactly one of *Groups or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Groups.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsPatchCall) Fields

func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsPatchCall) Header

func (c *GroupsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsService

type GroupsService struct {
	// contains filtered or unexported fields
}

func NewGroupsService

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService) Get

func (r *GroupsService) Get(groupUniqueId string) *GroupsGetCall

Get: Gets one resource by id.

func (*GroupsService) Patch

func (r *GroupsService) Patch(groupUniqueId string, groups *Groups) *GroupsPatchCall

Patch: Updates an existing resource. This method supports patch semantics.

func (*GroupsService) Update

func (r *GroupsService) Update(groupUniqueId string, groups *Groups) *GroupsUpdateCall

Update: Updates an existing resource.

type GroupsUpdateCall

type GroupsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*GroupsUpdateCall) Context

func (c *GroupsUpdateCall) Context(ctx context.Context) *GroupsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsUpdateCall) Do

func (c *GroupsUpdateCall) Do(opts ...googleapi.CallOption) (*Groups, error)

Do executes the "groupsSettings.groups.update" call. Exactly one of *Groups or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Groups.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsUpdateCall) Fields

func (c *GroupsUpdateCall) Fields(s ...googleapi.Field) *GroupsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsUpdateCall) Header

func (c *GroupsUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Groups *GroupsService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)