FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

python-gitlab/docs/gl_objects/notifications.rst at v8.6.0 · python-gitlab/python-gitlab · GitHub

Repository navigation

Latest commit

 

History

History
59 lines (45 loc) · 1.83 KB

File metadata and controls

59 lines (45 loc) · 1.83 KB

Notification settings

You can define notification settings globally, for groups and for projects. Valid levels are defined as constants:

  • gitlab.const.NotificationLevel.DISABLED
  • gitlab.const.NotificationLevel.PARTICIPATING
  • gitlab.const.NotificationLevel.WATCH
  • gitlab.const.NotificationLevel.GLOBAL
  • gitlab.const.NotificationLevel.MENTION
  • gitlab.const.NotificationLevel.CUSTOM

You get access to fine-grained settings if you use the NOTIFICATION_LEVEL_CUSTOM level.

Reference

  • v4 API:
    • :class:`gitlab.v4.objects.NotificationSettings`
    • :class:`gitlab.v4.objects.NotificationSettingsManager`
    • :attr:`gitlab.Gitlab.notificationsettings`
    • :class:`gitlab.v4.objects.GroupNotificationSettings`
    • :class:`gitlab.v4.objects.GroupNotificationSettingsManager`
    • :attr:`gitlab.v4.objects.Group.notificationsettings`
    • :class:`gitlab.v4.objects.ProjectNotificationSettings`
    • :class:`gitlab.v4.objects.ProjectNotificationSettingsManager`
    • :attr:`gitlab.v4.objects.Project.notificationsettings`
  • GitLab API: https://docs.gitlab.com/api/notification_settings

Examples

Get the notifications settings:

# global settings
settings = gl.notificationsettings.get()
# for a group
settings = gl.groups.get(group_id).notificationsettings.get()
# for a project
settings = gl.projects.get(project_id).notificationsettings.get()

Update the notifications settings:

# use a predefined level
settings.level = gitlab.const.NotificationLevel.WATCH

# create a custom setup
settings.level = gitlab.const.NotificationLevel.CUSTOM
settings.save()  # will create additional attributes, but not mandatory

settings.new_merge_request = True
settings.new_issue = True
settings.new_note = True
settings.save()

Back | FazBrowse Home | New Git URL