Package org.gitlab4j.api

Class NotificationSettingsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.NotificationSettingsApi

All Implemented Interfaces:

Constants

public class NotificationSettingsApi
extends AbstractApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
NotificationSettingsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
NotificationSettings	getGlobalNotificationSettings()	Get the global notification settings.
NotificationSettings	getGroupNotificationSettings(long groupId)	Get the notification settings for a group.
NotificationSettings	getProjectNotificationSettings(long projectId)	Get the notification settings for a project.
NotificationSettings	updateGlobalNotificationSettings(NotificationSettings settings)	Update the global notification settings.
NotificationSettings	updateGroupNotificationSettings(long groupId, NotificationSettings settings)	Update the notification settings for a group
NotificationSettings	updateProjectNotificationSettings(long projectId, NotificationSettings settings)	Update the notification settings for a project

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotificationSettingsApi

public NotificationSettingsApi(GitLabApi gitLabApi)

Method Details

getGlobalNotificationSettings

public NotificationSettings getGlobalNotificationSettings()
                                                   throws GitLabApiException

Get the global notification settings.

GitLab Endpoint: GET /notification_settings

Returns:

a NotificationSettings instance containing the global notification settings

Throws:

GitLabApiException - if any exception occurs

updateGlobalNotificationSettings

public NotificationSettings updateGlobalNotificationSettings(NotificationSettings settings)
                                                      throws GitLabApiException

Update the global notification settings.

GitLab Endpoint: PUT /notification_settings

Parameters:

settings - a NotificationSettings instance with the new settings

Returns:

a NotificationSettings instance containing the updated global notification settings

Throws:

GitLabApiException - if any exception occurs

getGroupNotificationSettings

public NotificationSettings getGroupNotificationSettings(long groupId)
                                                  throws GitLabApiException

Get the notification settings for a group.

GitLab Endpoint: GET /groups/:id/notification_settings

Parameters:

groupId - the group ID to get the notification settings for

Returns:

a NotificationSettings instance containing the specified group's notification settings

Throws:

GitLabApiException - if any exception occurs

updateGroupNotificationSettings

public NotificationSettings updateGroupNotificationSettings(long groupId,
 NotificationSettings settings)
                                                     throws GitLabApiException

Update the notification settings for a group

GitLab Endpoint: PUT /groups/:id/notification_settings

Parameters:

groupId - the group ID to update the notification settings for

settings - a NotificationSettings instance with the new settings

Returns:

a NotificationSettings instance containing the updated group notification settings

Throws:

GitLabApiException - if any exception occurs

getProjectNotificationSettings

public NotificationSettings getProjectNotificationSettings(long projectId)
                                                    throws GitLabApiException

Get the notification settings for a project.

GitLab Endpoint: GET /projects/:id/notification_settings

Parameters:

projectId - the project ID to get the notification settings for

Returns:

a NotificationSettings instance containing the specified project's notification settings

Throws:

GitLabApiException - if any exception occurs

updateProjectNotificationSettings

public NotificationSettings updateProjectNotificationSettings(long projectId,
 NotificationSettings settings)
                                                       throws GitLabApiException

Update the notification settings for a project

GitLab Endpoint: PUT /projects/:id/notification_settings

Parameters:

projectId - the project ID to update the notification settings for

settings - a NotificationSettings instance with the new settings

Returns:

a NotificationSettings instance containing the updated project notification settings

Throws:

GitLabApiException - if any exception occurs