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

Included in:

BWAPI::Client::Projects

Defined in:

lib/bwapi/client/projects/signals.rb

Instance Method Summary

• #set_signal_vote(id, opts) ⇒ Hashie::Mash

  Set the vote type and comment of a signal for a given user.

• #signals(id, opts) ⇒ Hashie::Mash

  Get all signals belonging to user in project.

Instance Method Details

#set_signal_vote(id, opts) ⇒ Hashie::Mash

Set the vote type and comment of a signal for a given user

Parameters:

• id (Integer) —

  Id of project

• opts (Hash) —

  options hash of parameters

Options Hash (opts):

• userId (Integer) —

  Id of the user

• voteType (Integer) —

  Type of vote

• comment (String) —

  User comment

• signalId (Integer) —

  Id of signal

• projectId (Integer) —

  Project id of the signal

Returns:

• (Hashie::Mash) —

  Update signal for given user

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

def set_signal_vote id, opts
  post "projects/#{project_id}/signals/vote", opts
end

#signals(id, opts) ⇒ Hashie::Mash

Get all signals belonging to user in project

Parameters:

• id (Integer) —

  Id of project

• opts (Hash) —

  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

• projectId (Integer) —

  Project id of the signal

• filter (Hash) —

  The filter(s) to apply

Returns:

• (Hashie::Mash) —

  All signals for user in project

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

def signals id, opts
  get "projects/#{id}/signals", opts
end