Module: BWAPI::Client::Projects::Signals

Includes:

Groups

Included in:

BWAPI::Client::Projects

Defined in:

lib/bwapi/client/projects/signals.rb,
lib/bwapi/client/projects/signals/groups.rb

Overview

Signals module for projects/signals endpoints

Defined Under Namespace

Modules: Groups

Instance Method Summary

• #signals(project_id, opts = {}) ⇒ Hash

  Get all signals belonging to user in project.

Methods included from Groups

#create_signal_group, #delete_signal_group, #get_signal_group, #signal_groups, #update_signal_group

Instance Method Details

#signals(project_id, opts = {}) ⇒ Hash

Get all signals belonging to user in project

Parameters:

• project_id (Integer) —

  Id of project

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

  options hash of parameters

Options Hash (opts):

• id (Integer) —

  Id of the query

• page (Integer) —

  Page of projects to retrieve

• pageSize (Integer) —

  Results per page of results

• importance (Integer) —

  Importance of signal

• type (String) —

  Type of signal

• filter (Hash) —

  The filter(s) to apply

Returns:

• (Hash) —

  All signals for user in project

# File 'lib/bwapi/client/projects/signals.rb', line 19

def signals(project_id, opts = {})
  get "projects/#{project_id}/signals", opts
end