diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
| commit | 5292ffb366f97e4dc611dfd49a1dca7d1e934f4c (patch) | |
| tree | 220659b39e0e5384504de3c63bbff003ad50eec2 /docs/gl_objects/notifications.rst | |
| parent | 2c342372814bbac2203d7b4c0f2cd32541bab979 (diff) | |
| download | gitlab-5292ffb366f97e4dc611dfd49a1dca7d1e934f4c.tar.gz | |
[docs] Rework the examples pages
* Get rid of the .py files and bring all the python examples in the RST
files
* Fix a few things
Diffstat (limited to 'docs/gl_objects/notifications.rst')
| -rw-r--r-- | docs/gl_objects/notifications.rst | 39 |
1 files changed, 19 insertions, 20 deletions
diff --git a/docs/gl_objects/notifications.rst b/docs/gl_objects/notifications.rst index a7310f3..ab0287f 100644 --- a/docs/gl_objects/notifications.rst +++ b/docs/gl_objects/notifications.rst @@ -30,31 +30,30 @@ Reference + :class:`gitlab.v4.objects.ProjectNotificationSettingsManager` + :attr:`gitlab.v4.objects.Project.notificationsettings` -* v3 API: - - + :class:`gitlab.v3.objects.NotificationSettings` - + :class:`gitlab.v3.objects.NotificationSettingsManager` - + :attr:`gitlab.Gitlab.notificationsettings` - + :class:`gitlab.v3.objects.GroupNotificationSettings` - + :class:`gitlab.v3.objects.GroupNotificationSettingsManager` - + :attr:`gitlab.v3.objects.Group.notificationsettings` - + :class:`gitlab.v3.objects.ProjectNotificationSettings` - + :class:`gitlab.v3.objects.ProjectNotificationSettingsManager` - + :attr:`gitlab.v3.objects.Project.notificationsettings` - * GitLab API: https://docs.gitlab.com/ce/api/notification_settings.html Examples -------- -Get the settings: +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:: -.. literalinclude:: notifications.py - :start-after: # get - :end-before: # end get + # use a predefined level + settings.level = gitlab.NOTIFICATION_LEVEL_WATCH -Update the settings: + # create a custom setup + settings.level = gitlab.NOTIFICATION_LEVEL_CUSTOM + settings.save() # will create additional attributes, but not mandatory -.. literalinclude:: notifications.py - :start-after: # update - :end-before: # end update + settings.new_merge_request = True + settings.new_issue = True + settings.new_note = True + settings.save() |