diff options
author | Hubert Chathi <hubert@uhoreg.ca> | 2020-12-26 20:38:48 -0500 |
---|---|---|
committer | Hubert Chathi <hubert@uhoreg.ca> | 2020-12-26 20:38:48 -0500 |
commit | cb2d7b6a97cfa1653dc3c2adf9ef85160f255aec (patch) | |
tree | 4bfe1408cfa38ba7770245652e3cb2063a273cbb | |
parent | Merge branch 'account_data' into 'master' (diff) |
fix formatting
-rw-r--r-- | lib/polyjuice/client/room.ex | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/lib/polyjuice/client/room.ex b/lib/polyjuice/client/room.ex index 26317ae..5dbf80d 100644 --- a/lib/polyjuice/client/room.ex +++ b/lib/polyjuice/client/room.ex @@ -312,9 +312,12 @@ defmodule Polyjuice.Client.Room do @doc """ Get a room state. + If `event_type` is not provided, returns a list of events. + If `event_type` and `state_key` are provided, returns an event content. - `state_key` can be omitted but this will return events that have a blank state key, not events that have "any state key". + `state_key` can be omitted but this will return events that have a blank state + key, not events that have "any state key". """ @spec get_state( client_api :: Polyjuice.Client.API.t(), @@ -336,15 +339,20 @@ defmodule Polyjuice.Client.Room do end @doc """ - Set up the read receipt marker positions for a given room - The history for a given room may be split into three sections: - messages the user has read (or indicated they aren't interested in them), - messages the user might have read some but not others, and messages the user hasn't seen yet. - The "fully read marker" (also known as a "read marker") marks the last event of the first section, - whereas the user's read receipt marks the last event of the second section. - it takes: - `fully_read`: the event id the read marker should be located at - `read`: the event id the to which the read receipt should be be up to + Set up the read receipt marker positions for a given room. + + The history for a given room may be split into three sections: + + 1. messages the user has read (or indicated they aren't interested in them), + 2. messages the user might have read some but not others, and + 3. messages the user hasn't seen yet. + + The "fully read marker" (also known as a "read marker") marks the last event + of the first section, whereas the user's read receipt marks the last event of + the second section. It takes: + + - `fully_read`: the event id the read marker should be located at + - `read`: the event id the to which the read receipt should be up to """ @spec update_read_markers( client_api :: Polyjuice.Client.API.t(), @@ -366,6 +374,7 @@ defmodule Polyjuice.Client.Room do @doc """ Create a new room with various configuration options and return a room_id on success. + `options` is a keyword list of options. Recognized options are: - `visibility`: a `:public` visibility indicates that the room will be shown in the published room list. A `:private` visibility will hide the room from |