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.



502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/discordrb/data.rb', line 502

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

#custom ⇒ true, 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)



500
501
502
 
# File 'lib/discordrb/data.rb', line 500

def custom
  @custom
end

#deprecated ⇒ true, 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)



497
498
499
 
# File 'lib/discordrb/data.rb', line 497

def deprecated
  @deprecated
end

#id ⇒ String (readonly) Also known as: to_s

Returns unique ID for the region.

Returns:

  • (String) —

    unique ID for the region



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

def id
  @id
end

#name ⇒ String (readonly)

Returns name of the region.

Returns:

  • (String) —

    name of the region



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

def name
  @name
end

#optimal ⇒ true, 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



494
495
496
 
# File 'lib/discordrb/data.rb', line 494

def optimal
  @optimal
end

#sample_hostname ⇒ String (readonly)

Returns an example hostname for the region.

Returns:

  • (String) —

    an example hostname for the region



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

def sample_hostname
  @sample_hostname
end

#sample_port ⇒ Integer (readonly)

Returns an example port for the region.

Returns:

  • (Integer) —

    an example port for the region



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

def sample_port
  @sample_port
end

#vip ⇒ true, false (readonly)

Returns if this is a VIP-only server.

Returns:

  • (true, false) —

    if this is a VIP-only server



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

def vip
  @vip
end