Class: Discordrb::Server

Inherits:
Object
  • Object
show all
Includes:
IDObject, ServerAttributes
Defined in:
lib/discordrb/data.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

Attributes included from ServerAttributes

#icon_id, #name

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from ServerAttributes

#icon_url

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.

Returns:

  • (Integer) —

    the amount of time after which a voice user gets moved into the AFK channel, in seconds.



2879
2880
2881
 
# File 'lib/discordrb/data.rb', line 2879

def afk_timeout
  @afk_timeout
end

#channels ⇒ Array<Channel> (readonly)

Returns an array of all the channels (text and voice) on this server.

Returns:

  • (Array<Channel>) —

    an array of all the channels (text and voice) on this server.



2858
2859
2860
 
# File 'lib/discordrb/data.rb', line 2858

def channels
  @channels
end

#emoji ⇒ Hash<Integer => Emoji> (readonly) Also known as: emojis

Returns a hash of all the emoji available on this server.

Returns:

  • (Hash<Integer => Emoji>) —

    a hash of all the emoji available on this server.



2864
2865
2866
 
# File 'lib/discordrb/data.rb', line 2864

def emoji
  @emoji
end

#features ⇒ Array<Symbol> (readonly)

Returns the features of the server (eg. "INVITE_SPLASH").

Returns:

  • (Array<Symbol>) —

    the features of the server (eg. "INVITE_SPLASH")



2873
2874
2875
 
# File 'lib/discordrb/data.rb', line 2873

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.

Returns:

  • (true, false) —

    whether or not this server is large (members > 100). If it is,



2869
2870
2871
 
# File 'lib/discordrb/data.rb', line 2869

def large
  @large
end

#member_count ⇒ Integer (readonly)

Returns the absolute number of members on this server, offline or not.

Returns:

  • (Integer) —

    the absolute number of members on this server, offline or not.



2876
2877
2878
 
# File 'lib/discordrb/data.rb', line 2876

def member_count
  @member_count
end

#owner ⇒ Member

Returns The server owner.

Returns:

  • (Member) —

    The server owner.



2855
2856
2857
 
# File 'lib/discordrb/data.rb', line 2855

def owner
  @owner
end

#region_id ⇒ String (readonly)

Returns the ID of the region the server is on (e.g. amsterdam).

Returns:

  • (String) —

    the ID of the region the server is on (e.g. amsterdam).



2852
2853
2854
 
# File 'lib/discordrb/data.rb', line 2852

def region_id
  @region_id
end

#roles ⇒ Array<Role> (readonly)

Returns an array of all the roles created on this server.

Returns:

  • (Array<Role>) —

    an array of all the roles created on this server.



2861
2862
2863
 
# File 'lib/discordrb/data.rb', line 2861

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.

Returns:

  • (Hash<Integer => VoiceState>) —

    the hash (user ID => voice state) of voice states of members on this server



2882
2883
2884
 
# File 'lib/discordrb/data.rb', line 2882

def voice_states
  @voice_states
end

Instance Method Details

#add_member_using_token(user, access_token, nick: nil, roles: [], deaf: false, mute: false) ⇒ Member

Note:

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

Parameters:

  • user (Integer, User, #resolve_id) —

    the user, or ID of the user to add to this server

  • access_token (String) —

    the OAuth2 Bearer token that has been granted the guilds.join scope

  • nick (String) (defaults to: nil) —

    the nickname to give this member upon joining

  • roles (Role, Array<Integer, Role, #resolve_id>) (defaults to: []) —

    the role (or roles) to give this member upon joining

  • deaf (true, false) (defaults to: false) —

    whether this member will be server deafened upon joining

  • mute (true, false) (defaults to: false) —

    whether this member will be server muted upon joining

Returns:

  • (Member) —

    the created member



3084
3085
3086
3087
3088
3089
 
# File 'lib/discordrb/data.rb', line 3084

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 = JSON.parse(API::Server.add_member(@bot.token, @id, user_id, access_token, nick, roles, deaf, mute))
  add_member Member.new(response, self, @bot)
end

#afk_channel ⇒ Channel?

Returns the AFK voice channel of this server, or nil if none is set.

Returns:

  • (Channel, nil) —

    the AFK voice channel of this server, or nil if none is set.



3540
3541
3542
 
# File 'lib/discordrb/data.rb', line 3540

def afk_channel
  @bot.channel(@afk_channel_id) if @afk_channel_id
end

#afk_channel=(afk_channel) ⇒ Object

Sets the server's AFK channel.

Parameters:

  • afk_channel (Channel, nil) —

    The new AFK channel, or nil if there should be none set.



3412
3413
3414
 
# File 'lib/discordrb/data.rb', line 3412

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.

Returns:

  • (true, false) —

    whether this server has any emoji or not.



3500
3501
3502
 
# File 'lib/discordrb/data.rb', line 3500

def any_emoji?
  @emoji.any?
end

#audit_logs(action: nil, user: nil, limit: 50, before: nil) ⇒ AuditLogs

Returns The server's audit logs.

Parameters:

  • action (Symbol) (defaults to: nil) —

    The action to only include.

  • user (User, #resolve_id) (defaults to: nil) —

    The user to filter entries to.

  • limit (Integer) (defaults to: 50) —

    The amount of entries to limit it to.

  • before (Entry, #resolve_id) (defaults to: nil) —

    The entry to use to not include all entries after it.

Returns:



2981
2982
2983
2984
2985
2986
2987
 
# File 'lib/discordrb/data.rb', line 2981

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.

Returns:

  • (Array<VoiceRegion>) —

    collection of available voice regions to this guild



3377
3378
3379
3380
3381
3382
3383
3384
 
# File 'lib/discordrb/data.rb', line 3377

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.

Parameters:

  • user (User, #resolve_id) —

    The user to ban.

  • message_days (Integer) (defaults to: 0) —

    How many days worth of messages sent by the user should be deleted.

  • reason (String) (defaults to: nil) —

    The reason the user is being banned.



3329
3330
3331
 
# File 'lib/discordrb/data.rb', line 3329

def ban(user, message_days = 0, reason: nil)
  API::Server.ban_user(@bot.token, @id, user.resolve_id, message_days, reason)
end

#bans ⇒ Array<ServerBan>

Returns a list of banned users on this server and the reason they were banned.

Returns:

  • (Array<ServerBan>) —

    a list of banned users on this server and the reason they were banned.



3318
3319
3320
3321
3322
3323
 
# File 'lib/discordrb/data.rb', line 3318

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

Parameters:

  • days (Integer) —

    the number of days to consider for inactivity (between 1 and 30)

  • reason (String) (defaults to: nil) —

    The reason the for the prune.

Returns:

  • (Integer) —

    the number of members removed at the end of the operation

Raises:

  • (ArgumentError) —

    if days is not between 1 and 30 (inclusive)



3107
3108
3109
3110
3111
3112
 
# File 'lib/discordrb/data.rb', line 3107

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

#categories ⇒ Array<Channel>

Returns an array of category channels on this server.

Returns:

  • (Array<Channel>) —

    an array of category channels on this server



3127
3128
3129
 
# File 'lib/discordrb/data.rb', line 3127

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, reason: nil) ⇒ Channel

Note:

If parent is provided, permission overwrites have the follow behavior:

  1. If overwrites is null, the new channel inherits the parent's permissions.
  2. If overwrites is [], the new channel inherits the parent's permissions.
  3. 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.

Parameters:

  • name (String) —

    Name of the channel to create

  • type (Integer, Symbol) (defaults to: 0) —

    Type of channel to create (0: text, 2: voice, 4: category)

  • topic (String) (defaults to: nil) —

    the topic of this channel, if it will be a text channel

  • bitrate (Integer) (defaults to: nil) —

    the bitrate of this channel, if it will be a voice channel

  • user_limit (Integer) (defaults to: nil) —

    the user limit of this channel, if it will be a voice channel

  • permission_overwrites (Array<Hash>, Array<Overwrite>) (defaults to: nil) —

    permission overwrites for this channel

  • parent (Channel, #resolve_id) (defaults to: nil) —

    parent category for this channel to be created in.

  • nsfw (true, false) (defaults to: false) —

    whether this channel should be created as nsfw

  • rate_limit_per_user (Integer) (defaults to: nil) —

    how many seconds users need to wait in between messages.

  • reason (String) (defaults to: nil) —

    The reason the for the creation of this channel.

Returns:

  • (Channel) —

    the created channel.

Raises:

  • (ArgumentError) —

    if type is not 0 (text), 2 (voice), or 4 (category)



3280
3281
3282
3283
3284
3285
3286
3287
 
# File 'lib/discordrb/data.rb', line 3280

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, reason: nil)
  type = Channel::TYPES[type] if type.is_a?(Symbol)
  raise ArgumentError, 'Channel type must be either 0 (text), 2 (voice), or 4 (category)!' unless [0, 2, 4].include?(type)
  permission_overwrites.map! { |e| e.is_a?(Overwrite) ? e.to_hash : e } if permission_overwrites.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, permission_overwrites, parent_id, nsfw, rate_limit_per_user, 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.

Parameters:

  • name (String) (defaults to: 'new role') —

    Name of the role to create

  • colour (Integer, ColourRGB, #combined) (defaults to: 0) —

    The roles colour

  • hoist (true, false) (defaults to: false)
  • mentionable (true, false) (defaults to: false)
  • permissions (Integer, Array<Symbol>, Permissions, #bits) (defaults to: 104_324_161) —

    The permissions to write to the new role.

  • reason (String) (defaults to: nil) —

    The reason the for the creation of this role.

Returns:

  • (Role) —

    the created role.



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/discordrb/data.rb', line 3299

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

  permissions = if permissions.is_a?(Array)
                  Permissions.bits(permissions)
                elsif permissions.respond_to?(:bits)
                  permissions.bits
                else
                  permissions
                end

  response = API::Server.create_role(@bot.token, @id, name, colour, hoist, mentionable, permissions, 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.

Parameters:

  • send_messages (true, false) (defaults to: false) —

    whether to additionally consider if the bot has Send Messages permission

Returns:

  • (Channel, nil) —

    The default channel on this server, or nil if there are no channels that the bot can read.



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/discordrb/data.rb', line 2919

def default_channel(send_messages = false)
  bot_member = member(@bot.profile)
  text_channels.sort_by { |e| [e.position, e.id] }.find do |e|
    if send_messages
      bot_member.can_read_messages?(e) && bot_member.can_send_messages?(e)
    else
      bot_member.can_read_messages?(e)
    end
  end
end

#default_message_notifications ⇒ Symbol

Returns the default message notifications settings of the server (:all = 'All messages', :mentions = 'Only @mentions').

Returns:

  • (Symbol) —

    the default message notifications settings of the server (:all = 'All messages', :mentions = 'Only @mentions').



3457
3458
3459
 
# File 'lib/discordrb/data.rb', line 3457

def default_message_notifications
  NOTIFICATION_LEVELS.key @default_message_notifications
end

#default_message_notifications=(notification_level) ⇒ Object Also known as: notification_level=

Sets the default message notification level

Parameters:



3463
3464
3465
3466
3467
 
# File 'lib/discordrb/data.rb', line 3463

def default_message_notifications=(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!



3355
3356
3357
 
# File 'lib/discordrb/data.rb', line 3355

def delete
  API::Server.delete(@bot.token, @id)
end

#embed_channel ⇒ Channel? Also known as: widget_channel

Returns the channel the server embed will make an invite for.

Returns:

  • (Channel, nil) —

    the channel the server embed will make an invite for.



3008
3009
3010
3011
 
# File 'lib/discordrb/data.rb', line 3008

def embed_channel
  cache_embed_data 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)

Parameters:



3033
3034
3035
 
# File 'lib/discordrb/data.rb', line 3033

def embed_channel=(channel)
  modify_embed(embed?, channel)
end

#embed_enabled=(value) ⇒ Object Also known as: widget_enabled=

Sets whether this server's embed (widget) is enabled

Parameters:

  • value (true, false) 


3016
3017
3018
 
# File 'lib/discordrb/data.rb', line 3016

def embed_enabled=(value)
  modify_embed(value, embed_channel)
end

#embed_enabled? ⇒ true, false Also known as: widget_enabled, widget?, embed?

Returns whether or not the server has widget enabled.

Returns:

  • (true, false) —

    whether or not the server has widget enabled



2999
3000
3001
3002
 
# File 'lib/discordrb/data.rb', line 2999

def embed_enabled?
  cache_embed_data if @embed_enabled.nil?
  @embed_enabled
end

#everyone_role ⇒ Role

Returns The @everyone role on this server.

Returns:

  • (Role) —

    The @everyone role on this server



2933
2934
2935
 
# File 'lib/discordrb/data.rb', line 2933

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.').

Returns:

  • (Symbol) —

    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.').



3485
3486
3487
 
# File 'lib/discordrb/data.rb', line 3485

def explicit_content_filter
  FILTER_LEVELS.key @explicit_content_filter
end

#explicit_content_filter=(filter_level) ⇒ Object

Sets the server content filter.

Parameters:



3493
3494
3495
3496
3497
 
# File 'lib/discordrb/data.rb', line 3493

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.

Parameters:

  • icon (String, #read) —

    The new icon, in base64-encoded JPG format.



3400
3401
3402
3403
3404
3405
3406
3407
3408
 
# File 'lib/discordrb/data.rb', line 3400

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



3599
3600
3601
 
# File 'lib/discordrb/data.rb', line 3599

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.

Returns:

  • (Array<Integration>) —

    an array of all the integrations connected to this server.



2971
2972
2973
2974
 
# File 'lib/discordrb/data.rb', line 2971

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.

Returns:

  • (Array<Invite>) —

    invites to the server.



3516
3517
3518
3519
 
# File 'lib/discordrb/data.rb', line 3516

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.

Parameters:

  • user (User, #resolve_id) —

    The user to kick.

  • reason (String) (defaults to: nil) —

    The reason the user is being kicked.



3343
3344
3345
 
# File 'lib/discordrb/data.rb', line 3343

def kick(user, reason = nil)
  API::Server.remove_member(@bot.token, @id, user.resolve_id, reason)
end

#leave ⇒ Object

Leave the server.



3360
3361
3362
 
# File 'lib/discordrb/data.rb', line 3360

def leave
  API::User.leave_server(@bot.token, @id)
end

#member(id, request = true) ⇒ Object

Gets a member on this server based on user ID

Parameters:

  • id (Integer) —

    The user ID to look for

  • request (true, false) (defaults to: true) —

    Whether the member should be requested from Discord if it's not cached



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
 
# File 'lib/discordrb/data.rb', line 2947

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
  nil
end

#members ⇒ Array<Member> Also known as: users

Returns an array of all the members on this server.

Returns:

  • (Array<Member>) —

    an array of all the members on this server.



2959
2960
2961
2962
2963
2964
2965
2966
 
# File 'lib/discordrb/data.rb', line 2959

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.

Parameters:

  • enabled (true, false) —

    whether the embed (widget) is enabled

  • channel (Channel, String, Integer, #resolve_id) —

    the channel to be referenced by the embed

  • reason (String, nil) (defaults to: nil) —

    the reason to be shown in the audit log for this action



3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/discordrb/data.rb', line 3052

def modify_embed(enabled, channel, reason = nil)
  cache_embed_data if @embed_enabled.nil?
  channel_id = channel ? channel.resolve_id : @embed_channel_id
  response = JSON.parse(API::Server.modify_embed(@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.

Parameters:



3350
3351
3352
 
# File 'lib/discordrb/data.rb', line 3350

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.

Parameters:

  • name (String) —

    The new server name.



3372
3373
3374
 
# File 'lib/discordrb/data.rb', line 3372

def name=(name)
  update_server_data(name: name)
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.

Parameters:

  • include_idle (true, false) (defaults to: false) —

    Whether to count idle members as online.

  • include_bots (true, false) (defaults to: true) —

    Whether to include bot accounts in the count.

Returns:

  • (Array<Member>) —

    an array of online members on this server.



3065
3066
3067
3068
3069
 
# File 'lib/discordrb/data.rb', line 3065

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.

Returns:

  • (Array<Channel>) —

    an array of channels on this server that are not in a category



3132
3133
3134
 
# File 'lib/discordrb/data.rb', line 3132

def orphan_channels
  @channels.reject { |c| c.parent || c.category? }
end

#prune_count(days) ⇒ Integer

Returns the amount of members that are candidates for pruning

Parameters:

  • days (Integer) —

    the number of days to consider for inactivity

Returns:

  • (Integer) —

    number of members to be removed

Raises:

  • (ArgumentError) —

    if days is not between 1 and 30 (inclusive)



3095
3096
3097
3098
3099
3100
 
# File 'lib/discordrb/data.rb', line 3095

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?

Note:

This may return nil if this server's voice region is deprecated.

Returns voice region data for this server's region.

Returns:

  • (VoiceRegion, nil) —

    voice region data for this server's region



3388
3389
3390
 
# File 'lib/discordrb/data.rb', line 3388

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.

Parameters:

  • region (String) —

    The new region the server should be in.



3394
3395
3396
 
# File 'lib/discordrb/data.rb', line 3394

def region=(region)
  update_server_data(region: region.to_s)
end

#role(id) ⇒ Object

Gets a role on this server based on its ID.

Parameters:



2939
2940
2941
2942
 
# File 'lib/discordrb/data.rb', line 2939

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)

Parameters:

  • channel (Channel, String, Integer, #resolve_id) —

    the channel to be referenced by the embed

  • reason (String, nil) (defaults to: nil) —

    the reason to be shown in the audit log for this action



3042
3043
3044
 
# File 'lib/discordrb/data.rb', line 3042

def set_embed_channel(channel, reason = nil)
  modify_embed(embed?, 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

Parameters:

  • value (true, false)
  • reason (String, nil) (defaults to: nil) —

    the reason to be shown in the audit log for this action



3025
3026
3027
 
# File 'lib/discordrb/data.rb', line 3025

def set_embed_enabled(value, reason = nil)
  modify_embed(value, embed_channel, reason)
end

#splash=(splash_hash) ⇒ Object

Sets the server splash

Parameters:

  • splash_hash (String) —

    The splash hash



3473
3474
3475
 
# File 'lib/discordrb/data.rb', line 3473

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.

Returns:

  • (String) —

    the hexadecimal ID used to identify this server's splash image for their VIP invite page.



3159
3160
3161
 
# File 'lib/discordrb/data.rb', line 3159

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.

Returns:

  • (String, nil) —

    the splash image URL for the server's VIP invite page. nil if there is no splash image.



3165
3166
3167
3168
3169
 
# File 'lib/discordrb/data.rb', line 3165

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.

Returns:

  • (Channel, nil) —

    the system channel (used for automatic welcome messages) of a server, or nil if none is set.



3545
3546
3547
 
# File 'lib/discordrb/data.rb', line 3545

def system_channel
  @bot.channel(@system_channel_id) if @system_channel_id
end

#system_channel=(system_channel) ⇒ Object

Sets the server's system channel.

Parameters:



3418
3419
3420
 
# File 'lib/discordrb/data.rb', line 3418

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.

Returns:

  • (Array<Channel>) —

    an array of text channels on this server



3117
3118
3119
 
# File 'lib/discordrb/data.rb', line 3117

def text_channels
  @channels.select(&:text?)
end

#unban(user, reason = nil) ⇒ Object

Unbans a previously banned user from this server.

Parameters:

  • user (User, #resolve_id) —

    The user to unban.

  • reason (String) (defaults to: nil) —

    The reason the user is being unbanned.



3336
3337
3338
 
# File 'lib/discordrb/data.rb', line 3336

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').

Returns:

  • (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').



3438
3439
3440
 
# File 'lib/discordrb/data.rb', line 3438

def verification_level
  VERIFICATION_LEVELS.key @verification_level
end

#verification_level=(level) ⇒ Object

Sets the verification level of the server

Parameters:



3444
3445
3446
3447
3448
 
# File 'lib/discordrb/data.rb', line 3444

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.

Returns:

  • (Array<Channel>) —

    an array of voice channels on this server



3122
3123
3124
 
# File 'lib/discordrb/data.rb', line 3122

def voice_channels
  @channels.select(&:voice?)
end

#webhooks ⇒ Array<Webhook>

Requests a list of Webhooks on the server.

Returns:

  • (Array<Webhook>) —

    webhooks on the server.



3509
3510
3511
3512
 
# File 'lib/discordrb/data.rb', line 3509

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.

Parameters:

  • style (Symbol) —

    The style the picture should have. Possible styles are:

    • :banner1 creates a rectangular image with the server name, member count and icon, a "Powered by Discord" message on the bottom and an arrow on the right.
    • :banner2 creates a less tall rectangular image that has the same information as banner1, but the Discord logo on the right - together with the arrow and separated by a diagonal separator.
    • :banner3 creates an image similar in size to banner1, but it has the arrow in the bottom part, next to the Discord logo and with a "Chat now" text.
    • :banner4 creates a tall, almost square, image that prominently features the Discord logo at the top and has a "Join my server" in a pill-style button on the bottom. The information about the server is in the same format as the other three banner styles.
    • :shield creates a very small, long rectangle, of the style you'd find at the top of GitHub README.md files. It features a small version of the Discord logo at the left and the member count at the right.

Returns:

  • (String, nil) —

    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.



3152
3153
3154
3155
3156
 
# File 'lib/discordrb/data.rb', line 3152

def widget_banner_url(style)
  update_data if @embed_enabled.nil?
  return unless @embed_enabled
  API.widget_url(@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.

Returns:

  • (String, nil) —

    the widget URL to the server that displays the amount of online members in a stylish way. nil if the widget is not enabled.



3138
3139
3140
3141
3142
 
# File 'lib/discordrb/data.rb', line 3138

def widget_url
  update_data if @embed_enabled.nil?
  return unless @embed_enabled
  API.widget_url(@id)
end