Polyjuice Client v0.4.2 Polyjuice.Client.UserDirectory View Source
User directory related functions.
Link to this section Summary
Functions
Search for a user.
Link to this section Functions
Link to this function
search_user(client_api, search_term, limit \\ nil)
View Sourcesearch_user( client_api :: Polyjuice.Client.API.t(), search_term :: String.t(), limit :: integer() | nil ) :: {:ok, map()} | any()
Search for a user.
search_term
can be any string.
limit
is the results limit, unlimited if not specified or nil
.
Examples:
iex> Polyjuice.Client.UserDirectory.search_user(client, "username")
{:ok,
%{
"limited" => false,
"results" => [
%{
"avatar_url" => nil,
"display_name" => "username",
"user_id" => "@username:kazarma.local"
}
]
}}
iex> Polyjuice.Client.UserDirectory.search_user(
...> client,
...> "username",
...> 10)
{:ok,
%{
"limited" => false,
"results" => [
%{
"avatar_url" => nil,
"display_name" => "username",
"user_id" => "@username:kazarma.local"
}
]
}}