Module: BWAPI::Client::CommandCenter::Displays::Screens

Included in:
BWAPI::Client::CommandCenter::Displays
Defined in:
lib/bwapi/client/command_center/displays/screens.rb

Overview

Displays module for commandcenter/displays/screens endpoints

Instance Method Summary collapse

Instance Method Details

#create_screen(display_id, opts = {}) ⇒ Hash

Create a new display screen

Parameters:

  • display_id (Integer) —

    The display id

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    The id of screen

  • name (String) —

    The name of the screen

  • displayId (Integer) —

    The display id

  • options (Hash) —

    Display options

  • screenIds (Array) —

    Screen ids used to display

  • created (String) —

    Date screen was created

  • enabled (Boolean) —

    Whether screen is enabled

Returns:

  • (Hash) —

    New display screen



45
46
47
 
# 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) ⇒ Hash

Delete an existing display screen

Parameters:

  • display_id (Integer) —

    The display id

  • screen_id (Integer) —

    The screen id

Returns:

  • (Hash) —

    Deleted display screen



70
71
72
 
# 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) ⇒ Hash

Get an existing display screen

Parameters:

  • display_id (Integer) —

    The display id

  • screen_id (Integer) —

    The screen id

Returns:

  • (Hash) —

    Specific screen for display



20
21
22
 
# 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) ⇒ Hash

Get an existing display screen with scenes

Parameters:

  • display_id (Integer) —

    The display id

  • screen_id (Integer) —

    The screen id

Returns:

  • (Hash) —

    Specific screen for display with scenes



29
30
31
 
# 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) ⇒ Hash

Get the screens for a display

Parameters:

  • display_id (Integer) —

    The display id

Returns:

  • (Hash) —

    All screens for display



11
12
13
 
# 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 = {}) ⇒ Hash

Update an existing display screen

Parameters:

  • display_id (Integer) —

    The display id

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    The id of screen

  • name (String) —

    The name of the screen

  • displayId (Integer) —

    The display id

  • options (Hash) —

    Display options

  • screenIds (Array) —

    Screen ids used to display

  • created (String) —

    Date screen was created

  • enabled (Boolean) —

    Whether screen is enabled

Returns:

  • (Hash) —

    Updated display screen



61
62
63
 
# 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