Class: Discordrb::VoiceRegion

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/data.rb

Overview

Voice regions are the locations of servers that handle voice communication in Discord

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ VoiceRegion

Returns a new instance of VoiceRegion.


492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/discordrb/data.rb', line 492

def initialize(data)
  @id = data['id']

  @name = data['name']

  @sample_hostname = data['sample_hostname']
  @sample_port = data['sample_port']

  @vip = data['vip']
  @optimal = data['optimal']
  @deprecated = data['deprecated']
  @custom = data['custom']
end

Instance Attribute Details

#customtrue, false (readonly)

Returns whether this is a custom voice region (used for events/etc).

Returns:

  • (true, false)

    whether this is a custom voice region (used for events/etc)


490
491
492
# File 'lib/discordrb/data.rb', line 490

def custom
  @custom
end

#deprecatedtrue, false (readonly)

Returns whether this is a deprecated voice region (avoid switching to these).

Returns:

  • (true, false)

    whether this is a deprecated voice region (avoid switching to these)


487
488
489
# File 'lib/discordrb/data.rb', line 487

def deprecated
  @deprecated
end

#idString (readonly) Also known as: to_s

Returns unique ID for the region.

Returns:

  • (String)

    unique ID for the region


468
469
470
# File 'lib/discordrb/data.rb', line 468

def id
  @id
end

#nameString (readonly)

Returns name of the region.

Returns:

  • (String)

    name of the region


472
473
474
# File 'lib/discordrb/data.rb', line 472

def name
  @name
end

#optimaltrue, false (readonly)

Returns if this voice server is the closest to the client.

Returns:

  • (true, false)

    if this voice server is the closest to the client


484
485
486
# File 'lib/discordrb/data.rb', line 484

def optimal
  @optimal
end

#sample_hostnameString (readonly)

Returns an example hostname for the region.

Returns:

  • (String)

    an example hostname for the region


475
476
477
# File 'lib/discordrb/data.rb', line 475

def sample_hostname
  @sample_hostname
end

#sample_portInteger (readonly)

Returns an example port for the region.

Returns:

  • (Integer)

    an example port for the region


478
479
480
# File 'lib/discordrb/data.rb', line 478

def sample_port
  @sample_port
end

#viptrue, false (readonly)

Returns if this is a VIP-only server.

Returns:

  • (true, false)

    if this is a VIP-only server


481
482
483
# File 'lib/discordrb/data.rb', line 481

def vip
  @vip
end