module BWAPI::Client::CommandCenter::Displays::Screens

Displays module for commandcenter/displays/screens endpoints

Public Instance Methods

create_screen(display_id, opts = {}) click to toggle source

Create a new display screen

@param [Integer] display_id The display id @param opts [Hash] options hash of parameters @option opts [Integer] id The id of screen @option opts [String] name The name of the screen @option opts [Integer] displayId The display id @option opts [Hash] options Display options @option opts [Array] screenIds Screen ids used to display @option opts [String] created Date screen was created @option opts [Boolean] enabled Whether screen is enabled @return [Hash] New display screen

# File lib/bwapi/client/command_center/displays/screens.rb, line 45
def create_screen(display_id, opts = {})
  post "commandcenter/displays/#{display_id}/screens", opts
end
delete_screen(display_id, screen_id) click to toggle source

Delete an existing display screen

@param [Integer] display_id The display id @param [Integer] screen_id The screen id @return [Hash] Deleted display screen

# File lib/bwapi/client/command_center/displays/screens.rb, line 70
def delete_screen(display_id, screen_id)
  delete "commandcenter/displays/#{display_id}/screens/#{screen_id}"
end
get_screen(display_id, screen_id) click to toggle source

Get an existing display screen

@param [Integer] display_id The display id @param [Integer] screen_id The screen id @return [Hash] Specific screen for display

# File lib/bwapi/client/command_center/displays/screens.rb, line 20
def get_screen(display_id, screen_id)
  get "commandcenter/displays/#{display_id}/screens/#{screen_id}"
end
get_screen_with_scenes(display_id, screen_id) click to toggle source

Get an existing display screen with scenes

@param [Integer] display_id The display id @param [Integer] screen_id The screen id @return [Hash] Specific screen for display with scenes

# File lib/bwapi/client/command_center/displays/screens.rb, line 29
def get_screen_with_scenes(display_id, screen_id)
  get "commandcenter/displays/#{display_id}/screens/#{screen_id}/withscenes"
end
screens(display_id) click to toggle source

Get the screens for a display

@param [Integer] display_id The display id @return [Hash] All screens for display

# File lib/bwapi/client/command_center/displays/screens.rb, line 11
def screens(display_id)
  get "commandcenter/displays/#{display_id}/screens"
end
update_screen(display_id, screen_id, opts = {}) click to toggle source

Update an existing display screen

@param [Integer] display_id The display id @param opts [Hash] options hash of parameters @option opts [Integer] id The id of screen @option opts [String] name The name of the screen @option opts [Integer] displayId The display id @option opts [Hash] options Display options @option opts [Array] screenIds Screen ids used to display @option opts [String] created Date screen was created @option opts [Boolean] enabled Whether screen is enabled @return [Hash] Updated display screen

# File lib/bwapi/client/command_center/displays/screens.rb, line 61
def update_screen(display_id, screen_id, opts = {})
  put "commandcenter/displays/#{display_id}/screens/#{screen_id}", opts
end