blob: 452370d8a240b11cd2e09cfa0b39031cd9a046a5 (
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
60
|
##################
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`
* v3 API:
+ :class:`gitlab.v3.objects.BroadcastMessage`
+ :class:`gitlab.v3.objects.BroadcastMessageManager`
+ :attr:`gitlab.Gitlab.broadcastmessages`
* GitLab API: https://docs.gitlab.com/ce/api/broadcast_messages.html
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
|
