Lingo.Api.Member (Lingo v0.4.2)

Guild members: fetching, editing, roles and kicks.

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

add_role(guild_id, user_id, role_id, opts \\ [])

Gives a member a role.

create(guild_id, user_id, access_token, params \\ [])

Adds a user to a guild with their OAuth2 token (guilds.join scope, see Lingo.OAuth2); the bot must be in the guild. Params: :nick, :roles, :mute, :deaf. Returns the member, or :ok when they were already in.

get(guild_id, user_id)

Fetches a guild member.

kick(guild_id, user_id, opts \\ [])

Removes a member from a guild.

list(guild_id, opts \\ [])

Lists guild members, limit: at a time (needs the guild members intent).

remove_role(guild_id, user_id, role_id, opts \\ [])

Takes a role away from a member.

search(guild_id, query, opts \\ [])

Finds guild members whose username or nickname starts with query.

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

Edits a guild member: nickname, roles, mute, deafen, timeout or voice channel.

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

Edits the bot's own profile in a guild: :nick, and :avatar, :banner (images as data URIs) and :bio, shown in that guild only.

Functions

add_role(guild_id, user_id, role_id, opts \\ [])

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

Gives a member a role.

create(guild_id, user_id, access_token, params \\ [])

@spec create(Lingo.Api.id(), Lingo.Api.id(), String.t(), Lingo.Api.params()) ::
  Lingo.Api.result(Lingo.Type.Member.t()) | :ok

Adds a user to a guild with their OAuth2 token (guilds.join scope, see Lingo.OAuth2); the bot must be in the guild. Params: :nick, :roles, :mute, :deaf. Returns the member, or :ok when they were already in.

get(guild_id, user_id)

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

Fetches a guild member.

kick(guild_id, user_id, opts \\ [])

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

Removes a member from a guild.

list(guild_id, opts \\ [])

@spec list(
  Lingo.Api.id(),
  keyword()
) :: Lingo.Api.result([Lingo.Type.Member.t()])

Lists guild members, limit: at a time (needs the guild members intent).

remove_role(guild_id, user_id, role_id, opts \\ [])

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

Takes a role away from a member.

search(guild_id, query, opts \\ [])

@spec search(Lingo.Api.id(), String.t(), keyword()) ::
  Lingo.Api.result([Lingo.Type.Member.t()])

Finds guild members whose username or nickname starts with query.

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

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

Edits a guild member: nickname, roles, mute, deafen, timeout or voice channel.

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

@spec update_current(Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.Member.t())

Edits the bot's own profile in a guild: :nick, and :avatar, :banner (images as data URIs) and :bio, shown in that guild only.