module BWAPI::Client::CommandCenter::Displays::Scenes

Displays module for commandcenter/displays/scenes endpoints

Public Instance Methods

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

Create a new display scene

@param [Integer] display_id The display id @param opts [Hash] options hash of parameters @option opts [Integer] id The id of scene @option opts [String] name The name of the scene @option opts [Integer] projectId The project id @option opts [Integer] displayId The display id @option opts [Hash] options Scene options @option opts [Integer] sceneTypeId Scene type id @option opts [Array] subSceneIds Sub Scene ids @option opts [String] created Date scene was created @option opts [Boolean] enabled Whether scene is enabled @option opts [Hash] filter Filter options @return [Hash] New display scene

# File lib/bwapi/client/command_center/displays/scenes.rb, line 48
def create_scene(display_id, opts = {})
  post "commandcenter/displays/#{display_id}/scenes", opts
end
delete_scene(display_id, scene_id) click to toggle source

Delete an existing display scene

@param [Integer] display_id The display id @param [Integer] scene_id The scene id @return [Hash] Deleted display scene

# File lib/bwapi/client/command_center/displays/scenes.rb, line 76
def delete_scene(display_id, scene_id)
  delete "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
end
get_scene(display_id, scene_id) click to toggle source

Get an existing display scene

@param [Integer] display_id The display id @param [Integer] scene_id The scene id @return [Hash] Specific scene for display

# File lib/bwapi/client/command_center/displays/scenes.rb, line 20
def get_scene(display_id, scene_id)
  get "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
end
get_scene_with_sub_scenes(display_id, scene_id) click to toggle source

Get an existing display scene sub scenes

@param [Integer] display_id The display id @param [Integer] scene_id The scene id @return [Hash] Specific sub scenes for display scene

# File lib/bwapi/client/command_center/displays/scenes.rb, line 29
def get_scene_with_sub_scenes(display_id, scene_id)
  get "commandcenter/displays/#{display_id}/scenes/#{scene_id}/subscenes"
end
scenes(display_id) click to toggle source

Get the scenes for an existing display

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

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

Update an existing display scene

@param [Integer] display_id The display id @param opts [Hash] options hash of parameters @option opts [Integer] id The id of scene @option opts String] name The name of the scene @option opts [Hash] options Scene options @option opts [Integer] projectId The project id @option opts [Integer] displayId The display id @option opts [Integer] sceneTypeId Scene type id @option opts [Array] subSceneIds Sub Scene ids @option opts [String] created Date scene was created @option opts [Boolean] enabled Whether scene is enabled @option opts [Hash] filter Filter options @return [Hash] Updated display scene

# File lib/bwapi/client/command_center/displays/scenes.rb, line 67
def update_scene(display_id, scene_id, opts = {})
  put "commandcenter/displays/#{display_id}/scenes/#{scene_id}", opts
end