Lingo.Api.StageInstance (Lingo v0.4.2)

Stage instances: live stages in stage channels.

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(params, opts \\ [])

Starts a stage instance in a stage channel.

delete(channel_id, opts \\ [])

Ends a stage instance.

get(channel_id)

Fetches the stage instance of a stage channel.

update(channel_id, params, opts \\ [])

Edits a stage instance.

Functions

create(params, opts \\ [])

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

Starts a stage instance in a stage channel.

delete(channel_id, opts \\ [])

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

Ends a stage instance.

get(channel_id)

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

Fetches the stage instance of a stage channel.

update(channel_id, params, opts \\ [])

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

Edits a stage instance.