Class: Discordrb::Server
- Inherits:
-
Object
- Object
- Discordrb::Server
- Includes:
- IDObject, ServerAttributes
- Defined in:
- lib/discordrb/data/server.rb
Overview
A server on Discord
Constant Summary collapse
- VERIFICATION_LEVELS =
A map of possible server verification levels to symbol names
{ none: 0, low: 1, medium: 2, high: 3, very_high: 4 }.freeze
- NOTIFICATION_LEVELS =
A map of possible message notification levels to symbol names
{ all_messages: 0, only_mentions: 1 }.freeze
- FILTER_LEVELS =
A map of possible content filter levels to symbol names
{ disabled: 0, members_without_roles: 1, all_members: 2 }.freeze
Instance Attribute Summary collapse
-
#afk_timeout ⇒ Integer
The amount of time after which a voice user gets moved into the AFK channel, in seconds.
-
#boost_level ⇒ Integer
readonly
The server's Nitro boost level.
-
#booster_count ⇒ Integer
readonly
The server's amount of Nitro boosters.
-
#channels ⇒ Array<Channel>
readonly
An array of all the channels (text and voice) on this server.
-
#emoji ⇒ Hash<Integer => Emoji>
(also: #emojis)
readonly
A hash of all the emoji available on this server.
-
#features ⇒ Array<Symbol>
readonly
The features of the server (eg. "INVITE_SPLASH").
-
#large ⇒ true, false
(also: #large?)
readonly
it means the members list may be inaccurate for a couple seconds after starting up the bot.
-
#member_count ⇒ Integer
readonly
The absolute number of members on this server, offline or not.
-
#region_id ⇒ String
readonly
The ID of the region the server is on (e.g.
amsterdam
). -
#roles ⇒ Array<Role>
readonly
An array of all the roles created on this server.
-
#voice_states ⇒ Hash<Integer => VoiceState>
readonly
The hash (user ID => voice state) of voice states of members on this server.
Attributes included from ServerAttributes
Attributes included from IDObject
Instance Method Summary collapse
-
#add_emoji(name, image, roles = [], reason: nil) ⇒ Emoji
Adds a new custom emoji on this server.
-
#add_member_using_token(user, access_token, nick: nil, roles: [], deaf: false, mute: false) ⇒ Member?
Adds a member to this guild that has granted this bot's application an OAuth2 access token with the
guilds.join
scope. -
#afk_channel ⇒ Channel?
The AFK voice channel of this server, or
nil
if none is set. -
#afk_channel=(afk_channel) ⇒ Object
Sets the server's AFK channel.
-
#any_emoji? ⇒ true, false
(also: #has_emoji?, #emoji?)
Whether this server has any emoji or not.
-
#audit_logs(action: nil, user: nil, limit: 50, before: nil) ⇒ AuditLogs
The server's audit logs.
-
#available_voice_regions ⇒ Array<VoiceRegion>
Collection of available voice regions to this guild.
-
#ban(user, message_days = 0, reason: nil) ⇒ Object
Bans a user from this server.
-
#banner_id ⇒ String
The hexadecimal ID used to identify this server's banner image, shown by the server name.
-
#banner_url ⇒ String?
The banner image URL for the server's banner image, or
nil
if there is no banner image. -
#bans ⇒ Array<ServerBan>
A list of banned users on this server and the reason they were banned.
-
#begin_prune(days, reason = nil) ⇒ Integer
(also: #prune)
Prunes (kicks) an amount of members for inactivity.
-
#bot ⇒ Member
The bot's own
Member
on this server. -
#bot_members ⇒ Array<Member>
An array of all the bot members on this server.
-
#categories ⇒ Array<Channel>
An array of category channels on this server.
-
#create_channel(name, type = 0, topic: nil, bitrate: nil, user_limit: nil, permission_overwrites: nil, parent: nil, nsfw: false, rate_limit_per_user: nil, position: nil, reason: nil) ⇒ Channel
Creates a channel on this server with the given name.
-
#create_role(name: 'new role', colour: 0, hoist: false, mentionable: false, permissions: 104_324_161, reason: nil) ⇒ Role
Creates a role on this server which can then be modified.
-
#default_channel(send_messages = false) ⇒ Channel?
(also: #general_channel)
The default channel is the text channel on this server with the highest position that the bot has Read Messages permission on.
-
#default_message_notifications ⇒ Symbol
The default message notifications settings of the server (:all = 'All messages', :mentions = 'Only @mentions').
-
#default_message_notifications=(notification_level) ⇒ Object
(also: #notification_level=)
Sets the default message notification level.
-
#delete ⇒ Object
Deletes this server.
-
#delete_emoji(emoji, reason: nil) ⇒ Object
Delete a custom emoji on this server.
-
#edit_emoji(emoji, name: nil, roles: nil, reason: nil) ⇒ Emoji
Changes the name and/or role whitelist of an emoji on this server.
-
#embed_channel ⇒ Channel?
(also: #widget_channel)
The channel the server embed will make an invite for.
-
#embed_channel=(channel) ⇒ Object
(also: #widget_channel=)
Changes the channel on the server's embed (widget).
-
#embed_enabled=(value) ⇒ Object
(also: #widget_enabled=)
Sets whether this server's embed (widget) is enabled.
-
#embed_enabled? ⇒ true, false
(also: #widget_enabled, #widget?, #embed?)
Whether or not the server has widget enabled.
-
#everyone_role ⇒ Role
The @everyone role on this server.
-
#explicit_content_filter ⇒ Symbol
(also: #content_filter_level)
The explicit content filter level of the server (:none = 'Don't scan any messages.', :exclude_roles = 'Scan messages for members without a role.', :all = 'Scan messages sent by all members.').
-
#explicit_content_filter=(filter_level) ⇒ Object
Sets the server content filter.
-
#icon=(icon) ⇒ Object
Sets the server's icon.
-
#inspect ⇒ Object
The inspect method is overwritten to give more useful output.
-
#integrations ⇒ Array<Integration>
An array of all the integrations connected to this server.
-
#invites ⇒ Array<Invite>
Requests a list of Invites to the server.
-
#kick(user, reason = nil) ⇒ Object
Kicks a user from this server.
-
#leave ⇒ Object
Leave the server.
-
#link ⇒ String
(also: #jump_link)
A URL that a user can use to navigate to this server in the client.
-
#max_emoji ⇒ Integer
The amount of emoji the server can have, based on its current Nitro Boost Level.
-
#member(id, request = true) ⇒ Object
Gets a member on this server based on user ID.
-
#members ⇒ Array<Member>
(also: #users)
An array of all the members on this server.
-
#modify_embed(enabled, channel, reason = nil) ⇒ Object
(also: #modify_widget)
Changes the channel on the server's embed (widget), and sets whether it is enabled.
-
#move(user, channel) ⇒ Object
Forcibly moves a user into a different voice channel.
-
#name=(name) ⇒ Object
Sets the server's name.
-
#non_bot_members ⇒ Array<Member>
An array of all the non bot members on this server.
-
#online_members(include_idle: false, include_bots: true) ⇒ Array<Member>
(also: #online_users)
An array of online members on this server.
-
#orphan_channels ⇒ Array<Channel>
An array of channels on this server that are not in a category.
-
#owner ⇒ Member
The server owner.
-
#owner=(user) ⇒ Object
Transfers server ownership to another user.
-
#prune_count(days) ⇒ Integer
Returns the amount of members that are candidates for pruning.
-
#region ⇒ VoiceRegion?
Voice region data for this server's region.
-
#region=(region) ⇒ Object
Moves the server to another region.
-
#role(id) ⇒ Object
Gets a role on this server based on its ID.
-
#set_embed_channel(channel, reason = nil) ⇒ Object
(also: #set_widget_channel)
Changes the channel on the server's embed (widget).
-
#set_embed_enabled(value, reason = nil) ⇒ Object
(also: #set_widget_enabled)
Sets whether this server's embed (widget) is enabled.
-
#splash=(splash_hash) ⇒ Object
Sets the server splash.
-
#splash_id ⇒ String
The hexadecimal ID used to identify this server's splash image for their VIP invite page.
-
#splash_url ⇒ String?
The splash image URL for the server's VIP invite page.
-
#system_channel ⇒ Channel?
The system channel (used for automatic welcome messages) of a server, or
nil
if none is set. -
#system_channel=(system_channel) ⇒ Object
Sets the server's system channel.
-
#text_channels ⇒ Array<Channel>
An array of text channels on this server.
-
#unban(user, reason = nil) ⇒ Object
Unbans a previously banned user from this server.
-
#verification_level ⇒ Symbol
The verification level of the server (:none = none, :low = 'Must have a verified email on their Discord account', :medium = 'Has to be registered with Discord for at least 5 minutes', :high = 'Has to be a member of this server for at least 10 minutes', :very_high = 'Must have a verified phone on their Discord account').
-
#verification_level=(level) ⇒ Object
Sets the verification level of the server.
-
#voice_channels ⇒ Array<Channel>
An array of voice channels on this server.
-
#webhooks ⇒ Array<Webhook>
Requests a list of Webhooks on the server.
-
#widget_banner_url(style) ⇒ String?
The widget banner URL to the server that displays the amount of online members, server icon and server name in a stylish way.
-
#widget_url ⇒ String?
The widget URL to the server that displays the amount of online members in a stylish way.
Methods included from ServerAttributes
Methods included from IDObject
#==, #creation_time, synthesise
Instance Attribute Details
#afk_timeout ⇒ Integer
Returns the amount of time after which a voice user gets moved into the AFK channel, in seconds.
51 52 53 |
# File 'lib/discordrb/data/server.rb', line 51 def afk_timeout @afk_timeout end |
#boost_level ⇒ Integer (readonly)
The server's Nitro boost level.
62 63 64 |
# File 'lib/discordrb/data/server.rb', line 62 def boost_level @boost_level end |
#booster_count ⇒ Integer (readonly)
The server's amount of Nitro boosters.
58 59 60 |
# File 'lib/discordrb/data/server.rb', line 58 def booster_count @booster_count end |
#channels ⇒ Array<Channel> (readonly)
Returns an array of all the channels (text and voice) on this server.
30 31 32 |
# File 'lib/discordrb/data/server.rb', line 30 def channels @channels end |
#emoji ⇒ Hash<Integer => Emoji> (readonly) Also known as: emojis
Returns a hash of all the emoji available on this server.
36 37 38 |
# File 'lib/discordrb/data/server.rb', line 36 def emoji @emoji end |
#features ⇒ Array<Symbol> (readonly)
Returns the features of the server (eg. "INVITE_SPLASH").
45 46 47 |
# File 'lib/discordrb/data/server.rb', line 45 def features @features end |
#large ⇒ true, false (readonly) Also known as: large?
it means the members list may be inaccurate for a couple seconds after starting up the bot.
41 42 43 |
# File 'lib/discordrb/data/server.rb', line 41 def large @large end |
#member_count ⇒ Integer (readonly)
Returns the absolute number of members on this server, offline or not.
48 49 50 |
# File 'lib/discordrb/data/server.rb', line 48 def member_count @member_count end |
#region_id ⇒ String (readonly)
Returns the ID of the region the server is on (e.g. amsterdam
).
27 28 29 |
# File 'lib/discordrb/data/server.rb', line 27 def region_id @region_id end |
#roles ⇒ Array<Role> (readonly)
Returns an array of all the roles created on this server.
33 34 35 |
# File 'lib/discordrb/data/server.rb', line 33 def roles @roles end |
#voice_states ⇒ Hash<Integer => VoiceState> (readonly)
Returns the hash (user ID => voice state) of voice states of members on this server.
54 55 56 |
# File 'lib/discordrb/data/server.rb', line 54 def voice_states @voice_states end |
Instance Method Details
#add_emoji(name, image, roles = [], reason: nil) ⇒ Emoji
Adds a new custom emoji on this server.
552 553 554 555 556 557 558 559 560 561 562 |
# File 'lib/discordrb/data/server.rb', line 552 def add_emoji(name, image, roles = [], reason: nil) image_string = image if image.respond_to? :read image_string = 'data:image/jpg;base64,' image_string += Base64.strict_encode64(image.read) end data = JSON.parse(API::Server.add_emoji(@bot.token, @id, image_string, name, roles.map(&:resolve_id), reason)) new_emoji = Emoji.new(data) @emoji[new_emoji.id] = new_emoji end |
#add_member_using_token(user, access_token, nick: nil, roles: [], deaf: false, mute: false) ⇒ Member?
Your bot must be present in this server, and have permission to create instant invites for this to work.
Adds a member to this guild that has granted this bot's application an OAuth2 access token
with the guilds.join
scope.
For more information about Discord's OAuth2 implementation, see: https://discordapp.com/developers/docs/topics/oauth2
286 287 288 289 290 291 292 293 |
# File 'lib/discordrb/data/server.rb', line 286 def add_member_using_token(user, access_token, nick: nil, roles: [], deaf: false, mute: false) user_id = user.resolve_id roles = roles.is_a?(Array) ? roles.map(&:resolve_id) : [roles.resolve_id] response = API::Server.add_member(@bot.token, @id, user_id, access_token, nick, roles, deaf, mute) return nil if response.empty? add_member Member.new(JSON.parse(response), self, @bot) end |
#afk_channel ⇒ Channel?
Returns the AFK voice channel of this server, or nil
if none is set.
822 823 824 |
# File 'lib/discordrb/data/server.rb', line 822 def afk_channel @bot.channel(@afk_channel_id) if @afk_channel_id end |
#afk_channel=(afk_channel) ⇒ Object
Sets the server's AFK channel.
694 695 696 |
# File 'lib/discordrb/data/server.rb', line 694 def afk_channel=(afk_channel) update_server_data(afk_channel_id: afk_channel.resolve_id) end |
#any_emoji? ⇒ true, false Also known as: has_emoji?, emoji?
Returns whether this server has any emoji or not.
782 783 784 |
# File 'lib/discordrb/data/server.rb', line 782 def any_emoji? @emoji.any? end |
#audit_logs(action: nil, user: nil, limit: 50, before: nil) ⇒ AuditLogs
Returns The server's audit logs.
182 183 184 185 186 187 188 189 |
# File 'lib/discordrb/data/server.rb', line 182 def audit_logs(action: nil, user: nil, limit: 50, before: nil) raise 'Invalid audit log action!' if action && AuditLogs::ACTIONS.key(action).nil? action = AuditLogs::ACTIONS.key(action) user = user.resolve_id if user before = before.resolve_id if before AuditLogs.new(self, @bot, JSON.parse(API::Server.audit_logs(@bot.token, @id, limit, user, action, before))) end |
#available_voice_regions ⇒ Array<VoiceRegion>
Returns collection of available voice regions to this guild.
659 660 661 662 663 664 665 666 |
# File 'lib/discordrb/data/server.rb', line 659 def available_voice_regions return @available_voice_regions if @available_voice_regions @available_voice_regions = {} data = JSON.parse API::Server.regions(@bot.token, @id) @available_voice_regions = data.map { |e| VoiceRegion.new e } end |
#ban(user, message_days = 0, reason: nil) ⇒ Object
Bans a user from this server.
611 612 613 |
# File 'lib/discordrb/data/server.rb', line 611 def ban(user, = 0, reason: nil) API::Server.ban_user(@bot.token, @id, user.resolve_id, , reason) end |
#banner_id ⇒ String
Returns the hexadecimal ID used to identify this server's banner image, shown by the server name.
379 380 381 |
# File 'lib/discordrb/data/server.rb', line 379 def @banner_id ||= JSON.parse(API::Server.resolve(@bot.token, @id))['banner'] end |
#banner_url ⇒ String?
Returns the banner image URL for the server's banner image, or
nil
if there is no banner image.
385 386 387 388 389 390 |
# File 'lib/discordrb/data/server.rb', line 385 def if @banner_id.nil? return unless API.(@id, @banner_id) end |
#bans ⇒ Array<ServerBan>
Returns a list of banned users on this server and the reason they were banned.
600 601 602 603 604 605 |
# File 'lib/discordrb/data/server.rb', line 600 def bans response = JSON.parse(API::Server.bans(@bot.token, @id)) response.map do |e| ServerBan.new(self, User.new(e['user'], @bot), e['reason']) end end |
#begin_prune(days, reason = nil) ⇒ Integer Also known as: prune
Prunes (kicks) an amount of members for inactivity
311 312 313 314 315 316 |
# File 'lib/discordrb/data/server.rb', line 311 def begin_prune(days, reason = nil) raise ArgumentError, 'Days must be between 1 and 30' unless days.between?(1, 30) response = JSON.parse API::Server.begin_prune(@bot.token, @id, days, reason) response['pruned'] end |
#bot ⇒ Member
Returns the bot's own Member
on this server.
167 168 169 |
# File 'lib/discordrb/data/server.rb', line 167 def bot member(@bot.profile) end |
#bot_members ⇒ Array<Member>
Returns an array of all the bot members on this server.
157 158 159 |
# File 'lib/discordrb/data/server.rb', line 157 def bot_members members.select(&:bot_account?) end |
#categories ⇒ Array<Channel>
Returns an array of category channels on this server.
331 332 333 |
# File 'lib/discordrb/data/server.rb', line 331 def categories @channels.select(&:category?) end |
#create_channel(name, type = 0, topic: nil, bitrate: nil, user_limit: nil, permission_overwrites: nil, parent: nil, nsfw: false, rate_limit_per_user: nil, position: nil, reason: nil) ⇒ Channel
If parent is provided, permission overwrites have the follow behavior:
- If overwrites is null, the new channel inherits the parent's permissions.
- If overwrites is [], the new channel inherits the parent's permissions.
- If you supply one or more overwrites, the channel will be created with those permissions and ignore the parents.
Creates a channel on this server with the given name.
508 509 510 511 512 513 514 515 516 |
# File 'lib/discordrb/data/server.rb', line 508 def create_channel(name, type = 0, topic: nil, bitrate: nil, user_limit: nil, permission_overwrites: nil, parent: nil, nsfw: false, rate_limit_per_user: nil, position: nil, reason: nil) type = Channel::TYPES[type] if type.is_a?(Symbol) raise ArgumentError, 'Channel type must be either 0 (text), 2 (voice), 4 (category), news (5), or store (6)!' unless [0, 2, 4, 5, 6].include?(type) .map! { |e| e.is_a?(Overwrite) ? e.to_hash : e } if .is_a?(Array) parent_id = parent.respond_to?(:resolve_id) ? parent.resolve_id : nil response = API::Server.create_channel(@bot.token, @id, name, type, topic, bitrate, user_limit, , parent_id, nsfw, rate_limit_per_user, position, reason) Channel.new(JSON.parse(response), @bot) end |
#create_role(name: 'new role', colour: 0, hoist: false, mentionable: false, permissions: 104_324_161, reason: nil) ⇒ Role
Creates a role on this server which can then be modified. It will be initialized with the regular role defaults the client uses unless specified, i.e. name is "new role", permissions are the default, colour is the default etc.
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'lib/discordrb/data/server.rb', line 528 def create_role(name: 'new role', colour: 0, hoist: false, mentionable: false, permissions: 104_324_161, reason: nil) colour = colour.respond_to?(:combined) ? colour.combined : colour = if .is_a?(Array) Permissions.bits() elsif .respond_to?(:bits) .bits else end response = API::Server.create_role(@bot.token, @id, name, colour, hoist, mentionable, , reason) role = Role.new(JSON.parse(response), @bot, self) @roles << role role end |
#default_channel(send_messages = false) ⇒ Channel? Also known as: general_channel
The default channel is the text channel on this server with the highest position that the bot has Read Messages permission on.
105 106 107 108 109 110 111 112 113 114 |
# File 'lib/discordrb/data/server.rb', line 105 def default_channel( = false) bot_member = member(@bot.profile) text_channels.sort_by { |e| [e.position, e.id] }.find do |e| if bot_member.(e) && bot_member.(e) else bot_member.(e) end end end |
#default_message_notifications ⇒ Symbol
Returns the default message notifications settings of the server (:all = 'All messages', :mentions = 'Only @mentions').
739 740 741 |
# File 'lib/discordrb/data/server.rb', line 739 def NOTIFICATION_LEVELS.key @default_message_notifications end |
#default_message_notifications=(notification_level) ⇒ Object Also known as: notification_level=
Sets the default message notification level
745 746 747 748 749 |
# File 'lib/discordrb/data/server.rb', line 745 def (notification_level) notification_level = NOTIFICATION_LEVELS[notification_level] if notification_level.is_a?(Symbol) update_server_data(default_message_notifications: notification_level) end |
#delete ⇒ Object
Deletes this server. Be aware that this is permanent and impossible to undo, so be careful!
637 638 639 |
# File 'lib/discordrb/data/server.rb', line 637 def delete API::Server.delete(@bot.token, @id) end |
#delete_emoji(emoji, reason: nil) ⇒ Object
Delete a custom emoji on this server
567 568 569 |
# File 'lib/discordrb/data/server.rb', line 567 def delete_emoji(emoji, reason: nil) API::Server.delete_emoji(@bot.token, @id, emoji.resolve_id, reason) end |
#edit_emoji(emoji, name: nil, roles: nil, reason: nil) ⇒ Emoji
Changes the name and/or role whitelist of an emoji on this server.
577 578 579 580 581 582 |
# File 'lib/discordrb/data/server.rb', line 577 def edit_emoji(emoji, name: nil, roles: nil, reason: nil) emoji = @emoji[emoji.resolve_id] data = JSON.parse(API::Server.edit_emoji(@bot.token, @id, emoji.resolve_id, name || emoji.name, (roles || emoji.roles).map(&:resolve_id), reason)) new_emoji = Emoji.new(data) @emoji[new_emoji.id] = new_emoji end |
#embed_channel ⇒ Channel? Also known as: widget_channel
Returns the channel the server embed will make an invite for.
210 211 212 213 |
# File 'lib/discordrb/data/server.rb', line 210 def if @embed_enabled.nil? @bot.channel(@embed_channel_id) if @embed_channel_id end |
#embed_channel=(channel) ⇒ Object Also known as: widget_channel=
Changes the channel on the server's embed (widget)
235 236 237 |
# File 'lib/discordrb/data/server.rb', line 235 def (channel) (, channel) end |
#embed_enabled=(value) ⇒ Object Also known as: widget_enabled=
Sets whether this server's embed (widget) is enabled
218 219 220 |
# File 'lib/discordrb/data/server.rb', line 218 def (value) (value, ) end |
#embed_enabled? ⇒ true, false Also known as: widget_enabled, widget?, embed?
Returns whether or not the server has widget enabled.
201 202 203 204 |
# File 'lib/discordrb/data/server.rb', line 201 def if @embed_enabled.nil? @embed_enabled end |
#everyone_role ⇒ Role
Returns The @everyone role on this server.
119 120 121 |
# File 'lib/discordrb/data/server.rb', line 119 def everyone_role role(@id) end |
#explicit_content_filter ⇒ Symbol Also known as: content_filter_level
Returns the explicit content filter level of the server (:none = 'Don't scan any messages.', :exclude_roles = 'Scan messages for members without a role.', :all = 'Scan messages sent by all members.').
767 768 769 |
# File 'lib/discordrb/data/server.rb', line 767 def explicit_content_filter FILTER_LEVELS.key @explicit_content_filter end |
#explicit_content_filter=(filter_level) ⇒ Object
Sets the server content filter.
775 776 777 778 779 |
# File 'lib/discordrb/data/server.rb', line 775 def explicit_content_filter=(filter_level) filter_level = FILTER_LEVELS[filter_level] if filter_level.is_a?(Symbol) update_server_data(explicit_content_filter: filter_level) end |
#icon=(icon) ⇒ Object
Sets the server's icon.
682 683 684 685 686 687 688 689 690 |
# File 'lib/discordrb/data/server.rb', line 682 def icon=(icon) if icon.respond_to? :read icon_string = 'data:image/jpg;base64,' icon_string += Base64.strict_encode64(icon.read) update_server_data(icon_id: icon_string) else update_server_data(icon_id: icon) end end |
#inspect ⇒ Object
The inspect method is overwritten to give more useful output
881 882 883 |
# File 'lib/discordrb/data/server.rb', line 881 def inspect "<Server name=#{@name} id=#{@id} large=#{@large} region=#{@region} owner=#{@owner} afk_channel_id=#{@afk_channel_id} system_channel_id=#{@system_channel_id} afk_timeout=#{@afk_timeout}>" end |
#integrations ⇒ Array<Integration>
Returns an array of all the integrations connected to this server.
172 173 174 175 |
# File 'lib/discordrb/data/server.rb', line 172 def integrations integration = JSON.parse(API::Server.integrations(@bot.token, @id)) integration.map { |element| Integration.new(element, @bot, self) } end |
#invites ⇒ Array<Invite>
Requests a list of Invites to the server.
798 799 800 801 |
# File 'lib/discordrb/data/server.rb', line 798 def invites invites = JSON.parse(API::Server.invites(@bot.token, @id)) invites.map { |invite| Invite.new(invite, @bot) } end |
#kick(user, reason = nil) ⇒ Object
Kicks a user from this server.
625 626 627 |
# File 'lib/discordrb/data/server.rb', line 625 def kick(user, reason = nil) API::Server.remove_member(@bot.token, @id, user.resolve_id, reason) end |
#leave ⇒ Object
Leave the server.
642 643 644 |
# File 'lib/discordrb/data/server.rb', line 642 def leave API::User.leave_server(@bot.token, @id) end |
#link ⇒ String Also known as: jump_link
Returns a URL that a user can use to navigate to this server in the client.
393 394 395 |
# File 'lib/discordrb/data/server.rb', line 393 def link "https://discordapp.com/channels/#{@id}" end |
#max_emoji ⇒ Integer
The amount of emoji the server can have, based on its current Nitro Boost Level.
586 587 588 589 590 591 592 593 594 595 596 597 |
# File 'lib/discordrb/data/server.rb', line 586 def max_emoji case @level when 1 100 when 2 150 when 3 250 else 50 end end |
#member(id, request = true) ⇒ Object
Gets a member on this server based on user ID
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/discordrb/data/server.rb', line 133 def member(id, request = true) id = id.resolve_id return @members[id] if member_cached?(id) return nil unless request member = @bot.member(self, id) @members[id] = member unless member.nil? rescue StandardError nil end |
#members ⇒ Array<Member> Also known as: users
Returns an array of all the members on this server.
145 146 147 148 149 150 151 152 |
# File 'lib/discordrb/data/server.rb', line 145 def members return @members.values if @chunked @bot.debug("Members for server #{@id} not chunked yet - initiating") @bot.request_chunks(@id) sleep 0.05 until @chunked @members.values end |
#modify_embed(enabled, channel, reason = nil) ⇒ Object Also known as: modify_widget
Changes the channel on the server's embed (widget), and sets whether it is enabled.
254 255 256 257 258 259 260 |
# File 'lib/discordrb/data/server.rb', line 254 def (enabled, channel, reason = nil) if @embed_enabled.nil? channel_id = channel ? channel.resolve_id : @embed_channel_id response = JSON.parse(API::Server.(@bot.token, @id, enabled, channel_id, reason)) @embed_enabled = response['enabled'] @embed_channel_id = response['channel_id'] end |
#move(user, channel) ⇒ Object
Forcibly moves a user into a different voice channel. Only works if the bot has the permission needed.
632 633 634 |
# File 'lib/discordrb/data/server.rb', line 632 def move(user, channel) API::Server.update_member(@bot.token, @id, user.resolve_id, channel_id: channel.resolve_id) end |
#name=(name) ⇒ Object
Sets the server's name.
654 655 656 |
# File 'lib/discordrb/data/server.rb', line 654 def name=(name) update_server_data(name: name) end |
#non_bot_members ⇒ Array<Member>
Returns an array of all the non bot members on this server.
162 163 164 |
# File 'lib/discordrb/data/server.rb', line 162 def non_bot_members members.reject(&:bot_account?) end |
#online_members(include_idle: false, include_bots: true) ⇒ Array<Member> Also known as: online_users
Returns an array of online members on this server.
267 268 269 270 271 |
# File 'lib/discordrb/data/server.rb', line 267 def online_members(include_idle: false, include_bots: true) @members.values.select do |e| ((include_idle ? e.idle? : false) || e.online?) && (include_bots ? true : !e.bot_account?) end end |
#orphan_channels ⇒ Array<Channel>
Returns an array of channels on this server that are not in a category.
336 337 338 |
# File 'lib/discordrb/data/server.rb', line 336 def orphan_channels @channels.reject { |c| c.parent || c.category? } end |
#owner ⇒ Member
Returns The server owner.
97 98 99 |
# File 'lib/discordrb/data/server.rb', line 97 def owner @owner ||= member(@owner_id) end |
#owner=(user) ⇒ Object
Transfers server ownership to another user.
648 649 650 |
# File 'lib/discordrb/data/server.rb', line 648 def owner=(user) API::Server.transfer_ownership(@bot.token, @id, user.resolve_id) end |
#prune_count(days) ⇒ Integer
Returns the amount of members that are candidates for pruning
299 300 301 302 303 304 |
# File 'lib/discordrb/data/server.rb', line 299 def prune_count(days) raise ArgumentError, 'Days must be between 1 and 30' unless days.between?(1, 30) response = JSON.parse API::Server.prune_count(@bot.token, @id, days) response['pruned'] end |
#region ⇒ VoiceRegion?
This may return nil
if this server's voice region is deprecated.
Returns voice region data for this server's region.
670 671 672 |
# File 'lib/discordrb/data/server.rb', line 670 def region available_voice_regions.find { |e| e.id == @region_id } end |
#region=(region) ⇒ Object
Moves the server to another region. This will cause a voice interruption of at most a second.
676 677 678 |
# File 'lib/discordrb/data/server.rb', line 676 def region=(region) update_server_data(region: region.to_s) end |
#role(id) ⇒ Object
Gets a role on this server based on its ID.
125 126 127 128 |
# File 'lib/discordrb/data/server.rb', line 125 def role(id) id = id.resolve_id @roles.find { |e| e.id == id } end |
#set_embed_channel(channel, reason = nil) ⇒ Object Also known as: set_widget_channel
Changes the channel on the server's embed (widget)
244 245 246 |
# File 'lib/discordrb/data/server.rb', line 244 def (channel, reason = nil) (, channel, reason) end |
#set_embed_enabled(value, reason = nil) ⇒ Object Also known as: set_widget_enabled
Sets whether this server's embed (widget) is enabled
227 228 229 |
# File 'lib/discordrb/data/server.rb', line 227 def (value, reason = nil) (value, , reason) end |
#splash=(splash_hash) ⇒ Object
Sets the server splash
755 756 757 |
# File 'lib/discordrb/data/server.rb', line 755 def splash=(splash_hash) update_server_data(splash: splash_hash) end |
#splash_id ⇒ String
Returns the hexadecimal ID used to identify this server's splash image for their VIP invite page.
365 366 367 |
# File 'lib/discordrb/data/server.rb', line 365 def splash_id @splash_id ||= JSON.parse(API::Server.resolve(@bot.token, @id))['splash'] end |
#splash_url ⇒ String?
Returns the splash image URL for the server's VIP invite page.
nil
if there is no splash image.
371 372 373 374 375 376 |
# File 'lib/discordrb/data/server.rb', line 371 def splash_url splash_id if @splash_id.nil? return nil unless @splash_id API.splash_url(@id, @splash_id) end |
#system_channel ⇒ Channel?
Returns the system channel (used for automatic welcome messages) of a server, or nil
if none is set.
827 828 829 |
# File 'lib/discordrb/data/server.rb', line 827 def system_channel @bot.channel(@system_channel_id) if @system_channel_id end |
#system_channel=(system_channel) ⇒ Object
Sets the server's system channel.
700 701 702 |
# File 'lib/discordrb/data/server.rb', line 700 def system_channel=(system_channel) update_server_data(system_channel_id: system_channel.resolve_id) end |
#text_channels ⇒ Array<Channel>
Returns an array of text channels on this server.
321 322 323 |
# File 'lib/discordrb/data/server.rb', line 321 def text_channels @channels.select(&:text?) end |
#unban(user, reason = nil) ⇒ Object
Unbans a previously banned user from this server.
618 619 620 |
# File 'lib/discordrb/data/server.rb', line 618 def unban(user, reason = nil) API::Server.unban_user(@bot.token, @id, user.resolve_id, reason) end |
#verification_level ⇒ Symbol
Returns the verification level of the server (:none = none, :low = 'Must have a verified email on their Discord account', :medium = 'Has to be registered with Discord for at least 5 minutes', :high = 'Has to be a member of this server for at least 10 minutes', :very_high = 'Must have a verified phone on their Discord account').
720 721 722 |
# File 'lib/discordrb/data/server.rb', line 720 def verification_level VERIFICATION_LEVELS.key @verification_level end |
#verification_level=(level) ⇒ Object
Sets the verification level of the server
726 727 728 729 730 |
# File 'lib/discordrb/data/server.rb', line 726 def verification_level=(level) level = VERIFICATION_LEVELS[level] if level.is_a?(Symbol) update_server_data(verification_level: level) end |
#voice_channels ⇒ Array<Channel>
Returns an array of voice channels on this server.
326 327 328 |
# File 'lib/discordrb/data/server.rb', line 326 def voice_channels @channels.select(&:voice?) end |
#webhooks ⇒ Array<Webhook>
Requests a list of Webhooks on the server.
791 792 793 794 |
# File 'lib/discordrb/data/server.rb', line 791 def webhooks webhooks = JSON.parse(API::Server.webhooks(@bot.token, @id)) webhooks.map { |webhook| Webhook.new(webhook, @bot) } end |
#widget_banner_url(style) ⇒ String?
Returns the widget banner URL to the server that displays the amount of online members,
server icon and server name in a stylish way. nil
if the widget is not enabled.
357 358 359 360 361 362 |
# File 'lib/discordrb/data/server.rb', line 357 def (style) update_data if @embed_enabled.nil? return unless @embed_enabled API.(@id, style) end |
#widget_url ⇒ String?
Returns the widget URL to the server that displays the amount of online members in a
stylish way. nil
if the widget is not enabled.
342 343 344 345 346 347 |
# File 'lib/discordrb/data/server.rb', line 342 def update_data if @embed_enabled.nil? return unless @embed_enabled API.(@id) end |