Retrieves a character by username.

Examples

> Bonfire.Me.Characters.by_username("username")
%Bonfire.Data.Identity.Character{}

Returns the appropriate mention prefix for a character type.

Examples

iex> Bonfire.Me.Characters.character_mention_prefix(%Bonfire.Data.Identity.User{})
"@"

Returns the canonical URL for a character.

Examples

iex> Bonfire.Me.Characters.character_url(%Bonfire.Data.Identity.Character{})
"http://example.com/character/username"

Cleans a username by replacing forbidden characters with underscores.

Examples

iex> Bonfire.Me.Characters.clean_username("invalid username!")
"invalid_username"

Displays a username with optional domain and prefix.

Examples

iex> Bonfire.Me.Characters.display_username("username")
"@username"

iex> Bonfire.Me.Characters.display_username("username", true, true, "@")
"@username@domain.com"

Retrieves multiple characters by IDs.

Examples

> Bonfire.Me.Characters.get("id_or_username")
%Bonfire.Data.Identity.Character{}

> Bonfire.Me.Characters.get(["id1", "id2"])
{:ok, [%Bonfire.Data.Identity.Character{}, %Bonfire.Data.Identity.Character{}]}

Checks if a username hash is available.

Examples

iex> Bonfire.Me.Characters.hash_available?("hash")
true

Deletes a character by username hash.

Examples

> Bonfire.Me.Characters.hash_delete("hash")

Callback implementation for Bonfire.Common.QueryModule.schema_module/0.

Updates a character with the given attributes.

Examples

> Bonfire.Me.Characters.update(%Bonfire.Data.Identity.Character{}, %{field: "value"})
{:ok, %Bonfire.Data.Identity.Character{}}

Checks if a username is available.

Examples

iex> Bonfire.Me.Characters.username_available?("non_existing_username")
true