Class: Bandwidth::UpdateConferenceMember

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/update_conference_member.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateConferenceMember

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::UpdateConferenceMember` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::UpdateConferenceMember`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'mute')
    self.mute = attributes[:'mute']
  end

  if attributes.key?(:'hold')
    self.hold = attributes[:'hold']
  end

  if attributes.key?(:'call_ids_to_coach')
    if (value = attributes[:'call_ids_to_coach']).is_a?(Array)
      self.call_ids_to_coach = value
    end
  end
end

Instance Attribute Details

#call_ids_to_coach ⇒ Object

If this member had a value set for ‘callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join.



25
26
27
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 25

def call_ids_to_coach
  @call_ids_to_coach
end

#hold ⇒ Object

Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. Updates this member’s hold status. Has no effect if omitted.



22
23
24
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 22

def hold
  @hold
end

#mute ⇒ Object

Whether or not this member is currently muted. Members who are muted are still able to hear other participants. Updates this member’s mute status. Has no effect if omitted.



19
20
21
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 19

def mute
  @mute
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



37
38
39
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 37

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 42

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



28
29
30
31
32
33
34
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 28

def self.attribute_map
  {
    :'mute' => :'mute',
    :'hold' => :'hold',
    :'call_ids_to_coach' => :'callIdsToCoach'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 133

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
60
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 56

def self.openapi_nullable
  Set.new([
    :'call_ids_to_coach'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 47

def self.openapi_types
  {
    :'mute' => :'Boolean',
    :'hold' => :'Boolean',
    :'call_ids_to_coach' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mute == o.mute &&
      hold == o.hold &&
      call_ids_to_coach == o.call_ids_to_coach
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



126
127
128
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 126

def hash
  [mute, hold, call_ids_to_coach].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



95
96
97
98
99
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 95

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 155

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



103
104
105
106
 
# File 'lib/bandwidth-sdk/models/update_conference_member.rb', line 103

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end