Lingo.Api.ScheduledEvent (Lingo v0.4.2)

Guild scheduled events.

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

Types

event_user()

A user interested in a scheduled event, with their guild member when asked for.

Functions

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

Creates a scheduled event.

delete(guild_id, event_id)

Deletes a scheduled event.

get(guild_id, event_id, opts \\ [])

Fetches a scheduled event.

list(guild_id, opts \\ [])

Lists a guild's scheduled events.

list_users(guild_id, event_id, opts \\ [])

Lists the users interested in a scheduled event, in user id order. Options: :limit, :with_member (include their guild member), :before and :after.

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

Edits a scheduled event, including starting or ending it.

Types

event_user()

@type event_user() :: %{
  guild_scheduled_event_id: Lingo.Api.id(),
  user: Lingo.Type.User.t(),
  member: Lingo.Type.Member.t() | nil
}

A user interested in a scheduled event, with their guild member when asked for.

Functions

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

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

Creates a scheduled event.

delete(guild_id, event_id)

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

Deletes a scheduled event.

get(guild_id, event_id, opts \\ [])

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

Fetches a scheduled event.

list(guild_id, opts \\ [])

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

Lists a guild's scheduled events.

list_users(guild_id, event_id, opts \\ [])

@spec list_users(Lingo.Api.id(), Lingo.Api.id(), keyword()) ::
  Lingo.Api.result([event_user()])

Lists the users interested in a scheduled event, in user id order. Options: :limit, :with_member (include their guild member), :before and :after.

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

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

Edits a scheduled event, including starting or ending it.