blob: ab0287fcaa685e2243c5bd1748cf744be3285725 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
#####################
Notification settings
#####################
You can define notification settings globally, for groups and for projects.
Valid levels are defined as constants:
* ``gitlab.NOTIFICATION_LEVEL_DISABLED``
* ``gitlab.NOTIFICATION_LEVEL_PARTICIPATING``
* ``gitlab.NOTIFICATION_LEVEL_WATCH``
* ``gitlab.NOTIFICATION_LEVEL_GLOBAL``
* ``gitlab.NOTIFICATION_LEVEL_MENTION``
* ``gitlab.NOTIFICATION_LEVEL_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/ce/api/notification_settings.html
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.NOTIFICATION_LEVEL_WATCH
# create a custom setup
settings.level = gitlab.NOTIFICATION_LEVEL_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()
|
