diff options
author | Matias Linares <matiaslina@gmail.com> | 2021-01-11 22:19:00 -0300 |
---|---|---|
committer | Matias Linares <matiaslina@gmail.com> | 2021-01-11 22:19:00 -0300 |
commit | 9da9134f0b28c0e4c69537b54fd96dca3a66aaed (patch) | |
tree | 46a14da15beb95dd6f2c6b995b2dc6e7b6e94970 /docs/Matrix/Client/Exception.rakudoc | |
parent | e5e5211aab9e6c579eeb6e78673015dcc03bb666 (diff) | |
download | perl6-matrix-client-9da9134f0b28c0e4c69537b54fd96dca3a66aaed.tar.gz |
[DOC] .pod6 -> .rakudoc extension & better layout
Diffstat (limited to 'docs/Matrix/Client/Exception.rakudoc')
-rw-r--r-- | docs/Matrix/Client/Exception.rakudoc | 52 |
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 |