View Source Nostrum.Struct.Guild.Integration (Nostrum v0.8.0)

Struct representing a Discord guild integration.

The struct defined here only has the fields provided for Discord Bot integrations available. If you use Nostrum in a non-bot application, feel free to open an issue to add it.

references

References

Link to this section Summary

Types

The integration account.

The bot/OAuth2 application for discord integrations

Whether this integration is enabled

The id of the guild this integration is for.

Snowflake ID of the integration

Name of the integration

t()

Represents a Guild integration

Integration type (Twitch, YouTube or Discord)

Link to this section Types

Link to this type

account()

View Source (since 0.5.1)

The integration account.

Link to this type

application()

View Source (since 0.5.1)
@type application() :: Nostrum.Struct.Guild.Integration.Application.t() | nil

The bot/OAuth2 application for discord integrations

Link to this type

enabled()

View Source (since 0.5.0)
@type enabled() :: boolean()

Whether this integration is enabled

Link to this type

guild_id()

View Source (since 0.5.1)
@type guild_id() :: Nostrum.Struct.Guild.id() | nil

The id of the guild this integration is for.

Only included when the Integration is sent via the gateway.

@type id() :: Nostrum.Snowflake.t()

Snowflake ID of the integration

@type name() :: String.t()

Name of the integration

@type t() :: %Nostrum.Struct.Guild.Integration{
  account: account(),
  application: application(),
  enabled: enabled(),
  guild_id: guild_id(),
  id: id(),
  name: name(),
  type: type()
}

Represents a Guild integration

@type type() :: String.t()

Integration type (Twitch, YouTube or Discord)