api: google.golang.org/api/groupssettings/v1 Index | Files

package groupssettings

import "google.golang.org/api/groupssettings/v1"

Package groupssettings provides access to the Groups Settings API.

For product documentation, see: https://developers.google.com/google-apps/groups-settings/get_started

Creating a client

Usage example:

import "google.golang.org/api/groupssettings/v1"
...
ctx := context.Background()
groupssettingsService, err := groupssettings.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

groupssettingsService, err := groupssettings.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
groupssettingsService, err := groupssettings.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

groupssettings-gen.go

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.

type Groups Uses

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"`

    // CustomRolesEnabledForSettingsToBeMerged: If any of the settings that
    // will be merged have custom roles which is anything other than owners,
    // managers, or group scopes.
    CustomRolesEnabledForSettingsToBeMerged string `json:"customRolesEnabledForSettingsToBeMerged,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"`

    // EnableCollaborativeInbox: If a primary Collab Inbox feature is
    // enabled.
    EnableCollaborativeInbox string `json:"enableCollaborativeInbox,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"`

    // WhoCanApproveMembers: Permission to approve members. Possible values
    // are: ALL_OWNERS_CAN_APPROVE ALL_MANAGERS_CAN_APPROVE
    // ALL_MEMBERS_CAN_APPROVE NONE_CAN_APPROVE
    WhoCanApproveMembers string `json:"whoCanApproveMembers,omitempty"`

    // WhoCanApproveMessages: Permission to approve pending messages in the
    // moderation queue. Possible values are: NONE OWNERS_ONLY
    // OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanApproveMessages string `json:"whoCanApproveMessages,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"`

    // WhoCanAssistContent: Permission for content assistants. Possible
    // values are: Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
    // OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanAssistContent string `json:"whoCanAssistContent,omitempty"`

    // WhoCanBanUsers: Permission to ban users. Possible values are: NONE
    // OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanBanUsers string `json:"whoCanBanUsers,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"`

    // WhoCanDeleteAnyPost: Permission to delete replies to topics. Possible
    // values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanDeleteAnyPost string `json:"whoCanDeleteAnyPost,omitempty"`

    // WhoCanDeleteTopics: Permission to delete topics. Possible values are:
    // NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanDeleteTopics string `json:"whoCanDeleteTopics,omitempty"`

    // WhoCanDiscoverGroup: Permission for who can discover the group.
    // Possible values are: ALL_MEMBERS_CAN_DISCOVER
    // ALL_IN_DOMAIN_CAN_DISCOVER ANYONE_CAN_DISCOVER
    WhoCanDiscoverGroup string `json:"whoCanDiscoverGroup,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"`

    // WhoCanHideAbuse: Permission to hide posts by reporting them as abuse.
    // Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY
    // OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanHideAbuse string `json:"whoCanHideAbuse,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"`

    // WhoCanLockTopics: Permission to lock topics. Possible values are:
    // NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanLockTopics string `json:"whoCanLockTopics,omitempty"`

    // WhoCanMakeTopicsSticky: Permission to make topics appear at the top
    // of the topic list. Possible values are: NONE OWNERS_ONLY
    // MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanMakeTopicsSticky string `json:"whoCanMakeTopicsSticky,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"`

    // WhoCanModerateContent: Permission for content moderation. Possible
    // values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanModerateContent string `json:"whoCanModerateContent,omitempty"`

    // WhoCanModerateMembers: Permission for membership moderation. Possible
    // values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
    WhoCanModerateMembers string `json:"whoCanModerateMembers,omitempty"`

    // WhoCanModifyMembers: Permission to modify members (change member
    // roles). Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS
    // ALL_MEMBERS
    WhoCanModifyMembers string `json:"whoCanModifyMembers,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"`

    // WhoCanMoveTopicsIn: Permission to move topics into the group or
    // forum. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS
    // ALL_MEMBERS
    WhoCanMoveTopicsIn string `json:"whoCanMoveTopicsIn,omitempty"`

    // WhoCanMoveTopicsOut: Permission to move topics out of the group or
    // forum. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS
    // ALL_MEMBERS
    WhoCanMoveTopicsOut string `json:"whoCanMoveTopicsOut,omitempty"`

    // WhoCanPostAnnouncements: Permission to post announcements, a special
    // topic type. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS
    // ALL_MEMBERS
    WhoCanPostAnnouncements string `json:"whoCanPostAnnouncements,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 ALL_OWNERS_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 Uses

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

type GroupsGetCall Uses

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

func (*GroupsGetCall) Context Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

func (*GroupsPatchCall) Context Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

func NewGroupsService Uses

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService) Get Uses

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

Get: Gets one resource by id.

func (*GroupsService) Patch Uses

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

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

func (*GroupsService) Update Uses

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

Update: Updates an existing resource.

type GroupsUpdateCall Uses

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

func (*GroupsUpdateCall) Context Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Package groupssettings imports 14 packages (graph) and is imported by 1 packages. Updated 2019-07-12. Refresh now. Tools for package owners.