Class: Connfu::Provisioning::Whitelist
- Inherits:
-
Object
- Object
- Connfu::Provisioning::Whitelist
- Defined in:
- lib/connfu/provisioning/whitelist.rb
Overview
This class models a conference whitelist
Instance Attribute Summary collapse
-
#users ⇒ Object
WhitelistUser array.
-
#voice ⇒ Object
readonly
Conference phone.
Class Method Summary collapse
-
.unmarshal(voice, data) ⇒ Object
Creates a Whitelist object using the raw data from the provisioning API ==== Parameters *
voicevoice channel unique identifier *dataraw data retrieved using the connFu API.
Instance Method Summary collapse
-
#each ⇒ Object
Iterator based on users array.
-
#initialize(voice, users = []) ⇒ Whitelist
constructor
A new instance of Whitelist.
- #to_s ⇒ Object
Constructor Details
#initialize(voice, users = []) ⇒ Whitelist
Returns a new instance of Whitelist.
15 16 17 18 |
# File 'lib/connfu/provisioning/whitelist.rb', line 15 def initialize(voice, users = []) @voice = voice @users = users end |
Instance Attribute Details
#users ⇒ Object
WhitelistUser array
10 11 12 |
# File 'lib/connfu/provisioning/whitelist.rb', line 10 def users @users end |
#voice ⇒ Object (readonly)
Conference phone
13 14 15 |
# File 'lib/connfu/provisioning/whitelist.rb', line 13 def voice @voice end |
Class Method Details
.unmarshal(voice, data) ⇒ Object
Creates a Whitelist object using the raw data from the provisioning API
Parameters
-
voicevoice channel unique identifier -
dataraw data retrieved using the connFu API
40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/connfu/provisioning/whitelist.rb', line 40 def self.unmarshal(voice, data) if data.is_a?(Array) numbers = [] data.each { |number| numbers << WhitelistUser.new(*number.values) } users = numbers else users = [WhitelistUser.new(*data.values)] end Whitelist.new(voice, users) end |
Instance Method Details
#each ⇒ Object
Iterator based on users array
21 22 23 24 25 |
# File 'lib/connfu/provisioning/whitelist.rb', line 21 def each users.each{|user| yield user } end |
#to_s ⇒ Object
27 28 29 30 31 32 33 |
# File 'lib/connfu/provisioning/whitelist.rb', line 27 def to_s value = [] self.instance_variables.each { |var| value << "#{var}: #{self.instance_variable_get(var)}" } value.join("\n").to_s end |