Class: Discorb::GuildTemplate::TemplateGuild

Inherits:
DiscordModel show all
Defined in:
lib/discorb/guild_template.rb

Overview

Represents a guild in guild template.

Defined Under Namespace

Classes: Channel, Role

Instance Attribute Summary collapse

Method Summary

Methods inherited from DiscordModel

#==, #eql?, #inspect

Instance Attribute Details

#afk_timeout ⇒ Integer (readonly)

Returns The AFK timeout of the guild.

Returns:

  • (Integer) —

    The AFK timeout of the guild.



136
137
138
 
# File 'lib/discorb/guild_template.rb', line 136

def afk_timeout
  @afk_timeout
end

#channels ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::GuildChannel} (readonly)

Returns A dictionary of channels in the guild.

Returns:



143
144
145
 
# File 'lib/discorb/guild_template.rb', line 143

def channels
  @channels
end

#default_message_notifications ⇒ :all_messages, :only_mentions (readonly)

Returns The default message notification level of the guild.

Returns:

  • (:all_messages, :only_mentions) —

    The default message notification level of the guild.



152
153
154
 
# File 'lib/discorb/guild_template.rb', line 152

def default_message_notifications
  @default_message_notifications
end

#description ⇒ String (readonly)

Returns The description of the guild.

Returns:

  • (String) —

    The description of the guild.



145
146
147
 
# File 'lib/discorb/guild_template.rb', line 145

def description
  @description
end

#explicit_content_filter ⇒ :disabled_in_text, ... (readonly)

Returns The explict content filter level of the guild.

Returns:

  • (:disabled_in_text, :members_without_roles, :all_members) —

    The explict content filter level of the guild.



154
155
156
 
# File 'lib/discorb/guild_template.rb', line 154

def explicit_content_filter
  @explicit_content_filter
end

#name ⇒ String (readonly)

Returns The name of the guild.

Returns:

  • (String) —

    The name of the guild.



134
135
136
 
# File 'lib/discorb/guild_template.rb', line 134

def name
  @name
end

#preferred_locale ⇒ Symbol (readonly)

Note:

This modifies the language code, - will be replaced with _.

Returns The preffered language of the guild.

Returns:

  • (Symbol) —

    The preffered language of the guild.



148
149
150
 
# File 'lib/discorb/guild_template.rb', line 148

def preferred_locale
  @preferred_locale
end

#roles ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::Role} (readonly)

Returns A dictionary of roles in the guild.

Returns:



138
139
140
 
# File 'lib/discorb/guild_template.rb', line 138

def roles
  @roles
end

#system_channel_flags ⇒ Discorb::SystemChannelFlag (readonly)

Returns The flag for the system channel.

Returns:



140
141
142
 
# File 'lib/discorb/guild_template.rb', line 140

def system_channel_flags
  @system_channel_flags
end

#verification_level ⇒ :none, ... (readonly)

Returns The verification level of the guild.

Returns:

  • (:none, :low, :medium, :high, :very_high) —

    The verification level of the guild.



150
151
152
 
# File 'lib/discorb/guild_template.rb', line 150

def verification_level
  @verification_level
end

#widget_enabled ⇒ Boolean (readonly) Also known as: widget_enabled?

Returns Whether the guild enabled the widget.

Returns:

  • (Boolean) —

    Whether the guild enabled the widget.



156
157
158
 
# File 'lib/discorb/guild_template.rb', line 156

def widget_enabled
  @widget_enabled
end