Class: VBox::Console

Inherits:
Base
  • Object
show all
Defined in:
lib/virtualbox/classes/console.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#_this, #delete!, #ensure_hash, #initialize, #vbox_class

Constructor Details

This class inherits a constructor from VBox::Base

Instance Attribute Details

#ref ⇒ Object (readonly)

Returns the value of attribute ref.



4
5
6
 
# File 'lib/virtualbox/classes/console.rb', line 4

def ref
  @ref
end

Instance Method Details

#adopt_saved_state(args = {}) ⇒ Object

Methods



71
72
73
74
 
# File 'lib/virtualbox/classes/console.rb', line 71

def adopt_saved_state(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_adopt_saved_state, _this.merge(args))
end

#attach_usb_device(args = {}) ⇒ Object 



76
77
78
79
 
# File 'lib/virtualbox/classes/console.rb', line 76

def attach_usb_device(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_attach_usb_device, _this.merge(args))
end

#attached_pci_devices ⇒ Object 



56
57
58
 
# File 'lib/virtualbox/classes/console.rb', line 56

def attached_pci_devices
  VBox::WebService.send_request(:i_console_get_attached_pci_devices, _this)
end

#create_shared_folder(args = {}) ⇒ Object 



81
82
83
84
 
# File 'lib/virtualbox/classes/console.rb', line 81

def create_shared_folder(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_create_shared_folder, _this.merge(args))
end

#delete_snapshot(args = {}) ⇒ Object 



86
87
88
89
90
 
# File 'lib/virtualbox/classes/console.rb', line 86

def delete_snapshot(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_console_delete_snapshot, _this.merge(args))
  VBox::Progress.new(progress)
end

#delete_snapshot_and_all_children(args = {}) ⇒ Object 



92
93
94
95
96
 
# File 'lib/virtualbox/classes/console.rb', line 92

def delete_snapshot_and_all_children(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_console_delete_snapshot_and_all_children, _this.merge(args))
  VBox::Progress.new(progress)
end

#delete_snapshot_range(args = {}) ⇒ Object 



98
99
100
101
102
 
# File 'lib/virtualbox/classes/console.rb', line 98

def delete_snapshot_range(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_console_delete_snapshot_range, _this.merge(args))
  VBox::Progress.new(progress)
end

#detach_usb_device(args = {}) ⇒ Object 



104
105
106
107
108
 
# File 'lib/virtualbox/classes/console.rb', line 104

def detach_usb_device(args={})
  ensure_hash(args)
  usb_device = VBox::WebService.send_request(:i_console_detach_usb_device, _this.merge(args))
  VBox::USBDevice.new(usb_device)
end

#discard_saved_state(args = {}) ⇒ Object 



110
111
112
113
 
# File 'lib/virtualbox/classes/console.rb', line 110

def discard_saved_state(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_discard_saved_state, _this.merge(args))
end

#event_source ⇒ Object 



51
52
53
54
 
# File 'lib/virtualbox/classes/console.rb', line 51

def event_source
  event_source = VBox::WebService.send_request(:i_console_get_event_source, _this)
  VBox::EventSource.new(event_source)
end

#find_usb_device_by_address(args = {}) ⇒ Object 



115
116
117
118
119
 
# File 'lib/virtualbox/classes/console.rb', line 115

def find_usb_device_by_address(args={})
  ensure_hash(args)
  usb_device = VBox::WebService.send_request(:i_console_find_usb_device_by_address, _this.merge(args))
  VBox::USBDevice.new(usb_device)
end

#find_usb_device_by_id(args = {}) ⇒ Object 



121
122
123
124
125
 
# File 'lib/virtualbox/classes/console.rb', line 121

def find_usb_device_by_id(args={})
  ensure_hash(args)
  usb_device = VBox::WebService.send_request(:i_console_find_usb_device_by_id, _this.merge(args))
  VBox::USBDevice.new(usb_device)
end

#get_device_activity(args = {}) ⇒ Object 



127
128
129
130
 
# File 'lib/virtualbox/classes/console.rb', line 127

def get_device_activity(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_get_device_activity, _this.merge(args))
end

#get_guest_entered_acpi_mode ⇒ Object 



132
133
134
 
# File 'lib/virtualbox/classes/console.rb', line 132

def get_guest_entered_acpi_mode
  VBox::WebService.send_request(:i_console_get_guest_entered_acpi_mode, _this)
end

#get_power_button_handled ⇒ Object 



136
137
138
 
# File 'lib/virtualbox/classes/console.rb', line 136

def get_power_button_handled
  VBox::WebService.send_request(:i_console_get_power_button_handled, _this)
end

#guest ⇒ Object 



17
18
19
20
 
# File 'lib/virtualbox/classes/console.rb', line 17

def guest
  guest = VBox::WebService.send_request(:i_console_get_guest, _this)
  VBox::Guest.new(guest)
end

#keyboard ⇒ Object 



22
23
24
25
 
# File 'lib/virtualbox/classes/console.rb', line 22

def keyboard
  guest = VBox::WebService.send_request(:i_console_get_keyboard, _this)
  VBox::Keyboard.new(guest)
end

#machine ⇒ Object

Attributes



8
9
10
11
 
# File 'lib/virtualbox/classes/console.rb', line 8

def machine
  machine = VBox::WebService.send_request(:i_console_get_machine, _this)
  VBox::Machine.new(machine)
end

#mouse ⇒ Object 



27
28
29
30
 
# File 'lib/virtualbox/classes/console.rb', line 27

def mouse
  guest = VBox::WebService.send_request(:i_console_get_mouse, _this)
  VBox::Mouse.new(guest)
end

#pause ⇒ Object 



140
141
142
 
# File 'lib/virtualbox/classes/console.rb', line 140

def pause
  VBox::WebService.send_request(:i_console_pause, _this)
end

#power_button ⇒ Object 



144
145
146
 
# File 'lib/virtualbox/classes/console.rb', line 144

def power_button
  VBox::WebService.send_request(:i_console_power_button, _this)
end

#power_down ⇒ Object 



148
149
150
151
 
# File 'lib/virtualbox/classes/console.rb', line 148

def power_down
  progress = VBox::WebService.send_request(:i_console_power_down, _this)
  VBox::Progress.new(progress)
end

#power_up ⇒ Object 



153
154
155
156
 
# File 'lib/virtualbox/classes/console.rb', line 153

def power_up
  progress = VBox::WebService.send_request(:i_console_power_up, _this)
  VBox::Progress.new(progress)
end

#power_up_paused ⇒ Object 



158
159
160
161
 
# File 'lib/virtualbox/classes/console.rb', line 158

def power_up_paused
  progress = VBox::WebService.send_request(:i_console_power_up_paused, _this)
  VBox::Progress.new(progress)
end

#remote_usb_devices ⇒ Object 



32
33
34
35
36
37
 
# File 'lib/virtualbox/classes/console.rb', line 32

def remote_usb_devices
  remote_usb_devices = VBox::WebService.send_request(:i_console_get_remote_usb_devices, _this)
  remote_usb_devices.map do |remote_usb_device|
    VBox::HostUSBDevice.new(remote_usb_device)
  end
end

#remove_shared_folder(args = {}) ⇒ Object 



163
164
165
166
 
# File 'lib/virtualbox/classes/console.rb', line 163

def remove_shared_folder(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_console_remove_shared_folder, _this.merge(args))
end

#reset ⇒ Object 



168
169
170
 
# File 'lib/virtualbox/classes/console.rb', line 168

def reset
  VBox::WebService.send_request(:i_console_reset, _this)
end

#restore_snapshot(args = {}) ⇒ Object 



172
173
174
175
176
 
# File 'lib/virtualbox/classes/console.rb', line 172

def restore_snapshot(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_console_restore_snapshot, _this.merge(args))
  VBox::Progress.new(progress)
end

#resume ⇒ Object 



178
179
180
 
# File 'lib/virtualbox/classes/console.rb', line 178

def resume
  VBox::WebService.send_request(:i_console_resume, _this)
end

#save_state ⇒ Object 



182
183
184
185
 
# File 'lib/virtualbox/classes/console.rb', line 182

def save_state
  progress = VBox::WebService.send_request(:i_console_save_state, _this)
  VBox::Progress.new(progress)
end

#shared_folders ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/virtualbox/classes/console.rb', line 39

def shared_folders
  shared_folders = VBox::WebService.send_request(:i_console_get_shared_folders, _this)
  shared_folders.map do |shared_folder|
    VBox::SharedFolder.new(shared_folder)
  end
end

#sleep_button ⇒ Object 



187
188
189
 
# File 'lib/virtualbox/classes/console.rb', line 187

def sleep_button
  VBox::WebService.send_request(:i_console_sleep_button, _this)
end

#state ⇒ Object 



13
14
15
 
# File 'lib/virtualbox/classes/console.rb', line 13

def state
  VBox::WebService.send_request(:i_console_get_machine_state, _this)
end

#take_snapshot ⇒ Object 



191
192
193
194
 
# File 'lib/virtualbox/classes/console.rb', line 191

def take_snapshot
  progress = VBox::WebService.send_request(:i_console_take_snapshot, _this)
  VBox::Progress.new(progress)
end

#teleport(args = {}) ⇒ Object 



196
197
198
199
 
# File 'lib/virtualbox/classes/console.rb', line 196

def teleport(args={})
  progress = VBox::WebService.send_request(:i_console_teleport, _this.merge(args))
  VBox::Progress.new(progress)
end

#use_host_clipboard ⇒ Object 



60
61
62
 
# File 'lib/virtualbox/classes/console.rb', line 60

def use_host_clipboard
  VBox::WebService.send_request(:i_console_get_use_host_clipboard, _this)
end

#use_host_clipboard=(use_host_clipboard) ⇒ Object 



64
65
66
67
 
# File 'lib/virtualbox/classes/console.rb', line 64

def use_host_clipboard=(use_host_clipboard)
  VBox::WebService.send_request(:i_console_set_use_host_clipboard,
                                _this.merge(:use_host_clipboard => use_host_clipboard))
end

#vrde_server_info ⇒ Object 



46
47
48
49
 
# File 'lib/virtualbox/classes/console.rb', line 46

def vrde_server_info
  vrde_server_info = VBox::WebService.send_request(:i_console_get_vrde_server_info, _this)
  VBox::VRDEServerInfo.new(vrde_server_info)
end