module BWAPI::Client::CommandCenter::Displays
Displays
module for commandcenter/displays endpoints
Public Instance Methods
Create a new display
@param opts [Hash] options hash of parameters @option opts [Integer] id The id of display @option opts [String] name The name of the display @option opts [Hash] options Display options @option opts [Array] screenIds Screen ids used to display @option opts [Boolean] active Whether display is active @option opts [String] created Date display was created @option opts [Boolean] enabled Whether display is enabled @return [Hash] New display
# File lib/bwapi/client/command_center/displays.rb, line 38 def create_display(opts = {}) post 'commandcenter/displays', opts end
Delete an existing display
@param [Integer] display_id the display id @return [Hash] Deleted display
# File lib/bwapi/client/command_center/displays.rb, line 62 def delete_display(display_id) delete "commandcenter/displays/#{display_id}" end
Get the displays visible to the user
@return [Hash] All displays
# File lib/bwapi/client/command_center/displays.rb, line 15 def displays get 'commandcenter/displays' end
Get an existing display
@param [Integer] display_id the display id @return [Hash] Specific display
# File lib/bwapi/client/command_center/displays.rb, line 23 def get_display(display_id) get "commandcenter/displays/#{display_id}" end
Update an existing display
@param [Integer] display_id the display id @param opts [Hash] options hash of parameters @option opts [Integer] id The id of display @option opts [String] name The name of the display @option opts [Hash] options Display options @option opts [Array] screenIds Screen ids used to display @option opts [Boolean] active Whether display is active @option opts [String] created Date display was created @option opts [Boolean] enabled Whether display is enabled @return [Hash] Updated display
# File lib/bwapi/client/command_center/displays.rb, line 54 def update_display(display_id, opts = {}) put "commandcenter/displays/#{display_id}", opts end