diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-08-11 16:07:04 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-08-11 16:07:04 +0200 |
| commit | 4057644f03829e4439ec8ab1feacf90c65d976eb (patch) | |
| tree | 977658ba5109c8a3b512a882bf0a037daad754cb /docs/gl_objects/notifications.rst | |
| parent | 80eab7b0c0682c5df99495acc4d6f71f36603cfc (diff) | |
| download | gitlab-4057644f03829e4439ec8ab1feacf90c65d976eb.tar.gz | |
Update the objects doc/examples for v4
Diffstat (limited to 'docs/gl_objects/notifications.rst')
| -rw-r--r-- | docs/gl_objects/notifications.rst | 46 |
1 files changed, 34 insertions, 12 deletions
diff --git a/docs/gl_objects/notifications.rst b/docs/gl_objects/notifications.rst index 472f710..a7310f3 100644 --- a/docs/gl_objects/notifications.rst +++ b/docs/gl_objects/notifications.rst @@ -5,22 +5,44 @@ Notification settings You can define notification settings globally, for groups and for projects. Valid levels are defined as constants: -* ``NOTIFICATION_LEVEL_DISABLED`` -* ``NOTIFICATION_LEVEL_PARTICIPATING`` -* ``NOTIFICATION_LEVEL_WATCH`` -* ``NOTIFICATION_LEVEL_GLOBAL`` -* ``NOTIFICATION_LEVEL_MENTION`` -* ``NOTIFICATION_LEVEL_CUSTOM`` +* ``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. -* Object classes: :class:`gitlab.objects.NotificationSettings` (global), - :class:`gitlab.objects.GroupNotificationSettings` (groups) and - :class:`gitlab.objects.ProjectNotificationSettings` (projects) -* Manager objects: :attr:`gitlab.Gitlab.notificationsettings` (global), - :attr:`gitlab.objects.Group.notificationsettings` (groups) and - :attr:`gitlab.objects.Project.notificationsettings` (projects) +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` + +* 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 -------- |