aboutsummaryrefslogtreecommitdiff
path: root/docs/Matrix/Client/Exception.rakudoc
diff options
context:
space:
mode:
authorMatias Linares <matiaslina@gmail.com>2021-01-11 22:48:16 -0300
committerMatias Linares <matiaslina@gmail.com>2021-01-11 22:48:16 -0300
commitf6397392c4fc88d1e9335bbbc4f91d8cb2f29368 (patch)
treedddb106193d48ca078946d2edb403ef75faca9dd /docs/Matrix/Client/Exception.rakudoc
parent14551a46b61a78a55cacf282e0534a1938215467 (diff)
parent289165e26df8830a15b6df1a63321583a2e67499 (diff)
downloadperl6-matrix-client-f6397392c4fc88d1e9335bbbc4f91d8cb2f29368.tar.gz
Merge branch 'documentation'
Diffstat (limited to 'docs/Matrix/Client/Exception.rakudoc')
-rw-r--r--docs/Matrix/Client/Exception.rakudoc52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/Matrix/Client/Exception.rakudoc b/docs/Matrix/Client/Exception.rakudoc
new file mode 100644
index 0000000..f814bbc
--- /dev/null
+++ b/docs/Matrix/Client/Exception.rakudoc
@@ -0,0 +1,52 @@
+=begin pod
+
+=TITLE Matrix::Client::Exception
+
+=SUBTITLE Module for all exceptions.
+
+=head1 X::Matrix::Response
+
+Error querying the matrix server
+
+
+ class X::Matrix::Response is Exception
+
+Error class when the matrix server returns an error code (4XX).
+
+=head2 METHODS
+
+=head3 code
+
+Returns the HTTP error code.
+
+=head3 error
+
+Returns a C<Str> with the matrix error. A full list of error codes can be
+found in the L<matrix spec|https://matrix.org/docs/spec/client_server/r0.4.0.html#api-standards>.
+
+=head3 message
+
+ method message(--> Str)
+
+Returns the exception message.
+
+=head1 X::Matrix::MXCParse
+
+Error while parsing a L<Matrix Content (MXC) URI|https://matrix.org/docs/spec/client_server/r0.6.1#matrix-content-mxc-uris>.
+
+ class X::Matrix::MXCParse is Exception
+
+
+=head2 METHODS
+
+=head3 code
+
+Returns the URI that failed to parse.
+
+=head3 message
+
+ method message(--> Str)
+
+Returns the exception message.
+
+=end pod