Skip to content

Commit

Permalink
Update matrix docs to mention title caveat (#354)
Browse files Browse the repository at this point in the history
* Update matrix docs to mention `title` caveat

* Update docs/services/matrix.md

Co-authored-by: nils måsén <[email protected]>

---------

Co-authored-by: nils måsén <[email protected]>
  • Loading branch information
simskij and piksel authored Jun 27, 2023
1 parent 04c6ea8 commit 11cd546
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/services/matrix.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Matrix

!!! note Usage of the `title` parameter
Do note that Matrix will discard any information put in the `title` parameter as the service has no analogue to a
a title. Instead, use a custom message format to supply your wanted title as part of the message.

## URL Format

*matrix://__`user`__:__`password`__@__`host`__:__`port`__/[?rooms=__`!roomID1`__[,__`roomAlias2`__]][&disableTLS=yes]*
Expand Down Expand Up @@ -37,4 +41,4 @@ Either omit them or URL encode them, I.E. `rooms=%23alias:server` or `rooms=alia
### TLS

If you do not have TLS enabled on the server you can disable it by providing `disableTLS=yes`. This will effectively
use `http` intead of `https` for the API calls.
use `http` intead of `https` for the API calls.

0 comments on commit 11cd546

Please sign in to comment.