summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorMax Wittig <max.wittig@siemens.com>2019-09-04 08:53:59 +0200
committerMax Wittig <max.wittig95@gmail.com>2019-09-04 23:16:26 +0200
commitb036347043a87a7f2d2df8be7658eb38c1f73183 (patch)
treec00a788437f790cb7d78aa15a2956a23070f146d /docs/gl_objects
parent0256c678ea9593c6371ffff60663f83c423ca872 (diff)
downloadgitlab-feat/status-api.tar.gz
feat(user): add status apifeat/status-api
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/users.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index e66ef3a..a276ce1 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -250,6 +250,44 @@ Delete an SSH key for a user::
# or
key.delete()
+Status
+======
+
+References
+----------
+
+You can manipulate SSH keys for the current user and for the other users if you
+are admin.
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.CurrentUserStatus`
+ + :class:`gitlab.v4.objects.CurrentUserStatusManager`
+ + :attr:`gitlab.v4.objects.CurrentUser.status`
+ + :class:`gitlab.v4.objects.UserStatus`
+ + :class:`gitlab.v4.objects.UserStatusManager`
+ + :attr:`gitlab.v4.objects.User.status`
+
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#user-status
+
+Examples
+--------
+
+Get current user status::
+
+ status = user.status.get()
+
+Update the status for the current user::
+
+ status = user.status.get()
+ status.message = "message"
+ status.emoji = "thumbsup"
+ status.save()
+
+Get the status of other users::
+
+ gl.users.get(1).status.get()
+
Emails
======