summaryrefslogtreecommitdiff
path: root/docs/gl_objects/messages.rst
blob: 9f183baf0eda9a5aca33da19d75f04e3f3fc0602 (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
##################
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.

* Object class: :class:`gitlab.objects.BroadcastMessage`
* Manager object: :attr:`gitlab.Gitlab.broadcastmessages`

Examples
--------

List the messages:

.. literalinclude:: messages.py
   :start-after: # list
   :end-before: # end list

Get a single message:

.. literalinclude:: messages.py
   :start-after: # get
   :end-before: # end get

Create a message:

.. literalinclude:: messages.py
   :start-after: # create
   :end-before: # end create

The date format for ``starts_at`` and ``ends_at`` parameters is
``YYYY-MM-ddThh:mm:ssZ``.

Update a message:

.. literalinclude:: messages.py
   :start-after: # update
   :end-before: # end update

Delete a message:

.. literalinclude:: messages.py
   :start-after: # delete
   :end-before: # end delete