Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update matrix docs to mention title caveat #354

Merged
merged 2 commits into from
Jun 27, 2023
Merged

Update matrix docs to mention title caveat #354

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cc3300
Update matrix docs to mention `title` caveat
simskij May 24, 2023
1bde80a
Update docs/services/matrix.md
simskij Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/services/matrix.md
View file
Open in desktop
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.