Module: BWAPI::Client::CommandCenter::Displays::Events

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

Overview

Displays module for commandcenter/displays/events endpoints

Instance Method Summary collapse

Instance Method Details

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

Create a new display event

Parameters:

  • display_id (Integer) —

    The display id

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    The event id

  • name (String) —

    The event name

  • description (String) —

    The event description

  • displayId (Integer) —

    The display id

  • matched (Boolean) —

    Events rules matched

  • queryId (Integer) —

    Reference query id

  • threshold (Integer) —

    Event mention volume threshold

  • action (Hash) —

    Event action

  • created (String) —

    Date event created

  • enabled (Boolean) —

    Whether event is enabled

  • filters (Hash) —

    Event filter options

Returns:

  • (Hash) —

    New display event



40
41
42
 
# File 'lib/bwapi/client/command_center/displays/events.rb', line 40

def create_event(display_id, opts = {})
  post "commandcenter/displays/#{display_id}/events", opts
end

#delete_event(display_id, event_id) ⇒ Hash

Delete an existing display event

Parameters:

  • display_id (Integer) —

    The display id

  • event_id (Integer) —

    The event id

Returns:

  • (Hash) —

    Deleted display event



69
70
71
 
# File 'lib/bwapi/client/command_center/displays/events.rb', line 69

def delete_event(display_id, event_id)
  delete "commandcenter/displays/#{display_id}/events/#{event_id}"
end

#events(display_id) ⇒ Hash

Get the events for an existing display

Parameters:

  • display_id (Integer) —

    The display id

Returns:

  • (Hash) —

    All events for display



11
12
13
 
# File 'lib/bwapi/client/command_center/displays/events.rb', line 11

def events(display_id)
  get "commandcenter/displays/#{display_id}/events"
end

#get_event(display_id, event_id) ⇒ Hash

Get an existing display event

Parameters:

  • display_id (Integer) —

    The display id

  • event_id (Integer) —

    The event id

Returns:

  • (Hash) —

    Specific event for display



20
21
22
 
# File 'lib/bwapi/client/command_center/displays/events.rb', line 20

def get_event(display_id, event_id)
  get "commandcenter/displays/#{display_id}/events/#{event_id}"
end

#update_event(display_id, event_id, opts = {}) ⇒ Hash

Update an existing display event

Parameters:

  • display_id (Integer) —

    The display id

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    The event id

  • name (String) —

    The event name

  • description (String) —

    The event description

  • displayId (Integer) —

    The display id

  • matched (Boolean) —

    Events rules matched

  • queryId (Integer) —

    Reference query id

  • threshold (Integer) —

    Event mention volume threshold

  • action (Hash) —

    Event action

  • created (String) —

    Date event created

  • enabled (Boolean) —

    Whether event is enabled

  • filters (Hash) —

    Event filter options

Returns:

  • (Hash) —

    Updated display event



60
61
62
 
# File 'lib/bwapi/client/command_center/displays/events.rb', line 60

def update_event(display_id, event_id, opts = {})
  put "commandcenter/displays/#{display_id}/events/#{event_id}", opts
end