diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-12-01 01:04:53 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-01 01:04:53 +0100 |
| commit | 8d76826fa64460e504acc5924f859f8dbc246b42 (patch) | |
| tree | 083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/messages.rst | |
| parent | 5a1678f43184bd459132102cc13cf8426fe0449d (diff) | |
| parent | 86ab04e54ea4175f10053decfad5086cda7aa024 (diff) | |
| download | gitlab-master.tar.gz | |
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/messages.rst')
| -rw-r--r-- | docs/gl_objects/messages.rst | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/gl_objects/messages.rst b/docs/gl_objects/messages.rst deleted file mode 100644 index 32fbb95..0000000 --- a/docs/gl_objects/messages.rst +++ /dev/null @@ -1,48 +0,0 @@ -################## -Broadcast messages -################## - -You can use broadcast messages to display information on all pages of the -gitlab web UI. You must have administration permissions to manipulate broadcast -messages. - -References ----------- - -* v4 API: - - + :class:`gitlab.v4.objects.BroadcastMessage` - + :class:`gitlab.v4.objects.BroadcastMessageManager` - + :attr:`gitlab.Gitlab.broadcastmessages` - -* GitLab API: https://docs.gitlab.com/ce/api/broadcast_messages.html - -Examples --------- - -List the messages:: - - msgs = gl.broadcastmessages.list() - -Get a single message:: - - msg = gl.broadcastmessages.get(msg_id) - -Create a message:: - - msg = gl.broadcastmessages.create({'message': 'Important information'}) - -The date format for the ``starts_at`` and ``ends_at`` parameters is -``YYYY-MM-ddThh:mm:ssZ``. - -Update a message:: - - msg.font = '#444444' - msg.color = '#999999' - msg.save() - -Delete a message:: - - gl.broadcastmessages.delete(msg_id) - # or - msg.delete() |