Lingo.Api.Role (Lingo v0.4.2)

Guild roles.

Every function returns {:ok, result}, :ok when Discord sends no body, or {:error, %Lingo.Error{}}. Calls go to the current bot (see Lingo.with_bot/2).

Summary

Functions

create(guild_id, params, opts \\ [])

Creates a role.

delete(guild_id, role_id, opts \\ [])

Deletes a role.

get(guild_id, role_id)

Fetches a role.

get_member_counts(guild_id)

Counts the members in each of a guild's roles, by role id, leaving out @everyone.

list(guild_id)

Lists a guild's roles.

update(guild_id, role_id, params, opts \\ [])

Edits a role.

update_positions(guild_id, positions, opts \\ [])

Moves roles, from a list of %{id:, position:} maps.

Functions

create(guild_id, params, opts \\ [])

@spec create(Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.Role.t())

Creates a role.

delete(guild_id, role_id, opts \\ [])

@spec delete(Lingo.Api.id(), Lingo.Api.id(), keyword()) :: Lingo.Api.result()

Deletes a role.

get(guild_id, role_id)

@spec get(Lingo.Api.id(), Lingo.Api.id()) :: Lingo.Api.result(Lingo.Type.Role.t())

Fetches a role.

get_member_counts(guild_id)

@spec get_member_counts(Lingo.Api.id()) ::
  Lingo.Api.result(%{required(Lingo.Api.id()) => non_neg_integer()})

Counts the members in each of a guild's roles, by role id, leaving out @everyone.

list(guild_id)

@spec list(Lingo.Api.id()) :: Lingo.Api.result([Lingo.Type.Role.t()])

Lists a guild's roles.

update(guild_id, role_id, params, opts \\ [])

@spec update(Lingo.Api.id(), Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.Role.t())

Edits a role.

update_positions(guild_id, positions, opts \\ [])

@spec update_positions(Lingo.Api.id(), [map()], keyword()) ::
  Lingo.Api.result([Lingo.Type.Role.t()])

Moves roles, from a list of %{id:, position:} maps.