Polyjuice Client v0.2.1 Polyjuice.Client.Filter View Source

Build filters.

https://matrix.org/docs/spec/client_server/r0.5.0#filtering

The functions in this module can be chained to create more complex filters.

Examples:

iex> Polyjuice.Client.Filter.include_state_types(["m.room.member"])
...> |> Polyjuice.Client.Filter.limit_timeline_events(10)
...> |> Polyjuice.Client.Filter.lazy_loading()
%{
  "room" => %{
    "state" => %{
      "types" => ["m.room.member"],
      "lazy_load_members" => true
    },
    "timeline" => %{
      "lazy_load_members" => true,
      "limit" => 10
    }
  }
}

Link to this section Summary

Functions

exclude_ephemeral_types(filter \\ %{}, types)

Don't allow certain types of ephemeral room events.

exclude_presence_types(filter \\ %{}, types)

Don't allow certain types of presence events.

exclude_state_types(filter \\ %{}, types)

Don't allow certain types of state events.

include_ephemeral_types(filter \\ %{}, types)

Allow certain types of ephemeral room events to be included.

include_presence_types(filter \\ %{}, types)

Allow certain types of presence events to be included.

include_state_types(filter \\ %{}, types)

Allow certain types of state events to be included.

lazy_loading(filter \\ %{})

limit_timeline_events(filter \\ %{}, limit)

Set the maximum number of timeline events.

Link to this section Functions