aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatias Linares <matiaslina@openmailbox.org>2018-06-09 16:43:35 -0300
committerMatias Linares <matiaslina@openmailbox.org>2018-06-09 16:43:35 -0300
commit5611f785dc62d7af68adc3ba9bd2c5199c38d96a (patch)
tree03e37d3ba928ec209c9b23383cae0bbfd31e2320 /docs
parent3968265131adb2f12dfa80f291069d01df4c341a (diff)
downloadperl6-matrix-client-5611f785dc62d7af68adc3ba9bd2c5199c38d96a.tar.gz
Add presence methods.
This adds a way to change and query the presence for users. Closes #4
Diffstat (limited to 'docs')
-rw-r--r--docs/client.pod614
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/client.pod6 b/docs/client.pod6
index a441b7c..0ff1e95 100644
--- a/docs/client.pod6
+++ b/docs/client.pod6
@@ -104,6 +104,20 @@ and then set that uploaded image as avatar.
Returns the user id of the client account.
+=head2 presence
+
+ method presence(Matrix::Client:D: $user-id? --> Matrix::Response::Presence)
+
+Query the presence status for an user. if no C<$user-id> is passed as argument,
+it will return the presence of the user associated with the client.
+
+=head2 set-presence
+
+ method set-presence(Matrix::Client:D: Str $presence, Str :$status-message = "")
+
+Sets the manually the presence of the client account. The C<$presence> argument
+must be C<“online”>, C<“offline”> or C<“unavailable”>.
+
=head2 sync
multi method sync(:$since = "")