Class: Punchblock::Command::Unjoin

Inherits:
Punchblock::CommandNode show all
Defined in:
lib/punchblock/command/unjoin.rb

Constant Summary

Constants inherited from RayoNode

RayoNode::InvalidNodeError

Instance Attribute Summary

Attributes inherited from RayoNode

#client, #component_id, #connection, #domain, #original_component, #target_call_id, #target_mixer_name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Punchblock::CommandNode

#initialize, #response, #response=, #write_attr

Methods inherited from RayoNode

class_from_registration, #eql?, import, #inspect, register, #source

Constructor Details

This class inherits a constructor from Punchblock::CommandNode

Class Method Details

.new(options = {}) ⇒ Command::Unjoin

Create an ujoin command

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :call_id (String, Optional) —

    the call ID to unjoin

  • :mixer_name (String, Optional) —

    the mixer name to unjoin

Returns:



17
18
19
20
21
 
# File 'lib/punchblock/command/unjoin.rb', line 17

def self.new(options = {})
  super().tap do |new_node|
    options.each_pair { |k,v| new_node.send :"#{k}=", v }
  end
end

Instance Method Details

#call_id ⇒ String

Returns the call ID to unjoin.

Returns:

  • (String) —

    the call ID to unjoin



25
26
27
 
# File 'lib/punchblock/command/unjoin.rb', line 25

def call_id
  read_attr :'call-id'
end

#call_id=(other) ⇒ Object

Parameters:

  • other (String) —

    the call ID to unjoin



31
32
33
 
# File 'lib/punchblock/command/unjoin.rb', line 31

def call_id=(other)
  write_attr :'call-id', other
end

#inspect_attributes ⇒ Object

:nodoc:



47
48
49
 
# File 'lib/punchblock/command/unjoin.rb', line 47

def inspect_attributes # :nodoc:
  [:call_id, :mixer_name] + super
end

#mixer_name ⇒ String

Returns the mixer name to unjoin.

Returns:

  • (String) —

    the mixer name to unjoin



37
38
39
 
# File 'lib/punchblock/command/unjoin.rb', line 37

def mixer_name
  read_attr :'mixer-name'
end

#mixer_name=(other) ⇒ Object

Parameters:

  • other (String) —

    the mixer name to unjoin



43
44
45
 
# File 'lib/punchblock/command/unjoin.rb', line 43

def mixer_name=(other)
  write_attr :'mixer-name', other
end