Module: BWAPI::Client::Admin

Includes:

Clients::Become, Clients::Search, Clients::SubClients, Clients::Users

Included in:

BWAPI::Client

Defined in:

lib/bwapi/client/admin.rb,
lib/bwapi/client/admin/users.rb,
lib/bwapi/client/admin/become.rb,
lib/bwapi/client/admin/search.rb,
lib/bwapi/client/admin/sub_clients.rb,
lib/bwapi/client/admin/users/sharing.rb

Defined Under Namespace

Modules: Clients

Instance Method Summary

• #active_queries(opts = {}) ⇒ Hashie::Mash

  Get the active queries irrespective of project.

• #sharing_report ⇒ Hashie::Mash

  Get the project report of sharing details.

Methods included from Clients::Users

#client_users, #create_client_user, #get_client_user, #update_client_user

Methods included from Clients::Users::Sharing

#client_users_sharing, #update_client_users_sharing

Methods included from Clients::Search

#search_query_name, #search_query_text, #search_rule_text

Methods included from Clients::SubClients

#client_sub_clients, #create_client_sub_client, #get_client_sub_client, #update_client_sub_client

Methods included from Clients::Become

#admin_become

Instance Method Details

#active_queries(opts = {}) ⇒ Hashie::Mash

Get the active queries irrespective of project

Parameters:

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

  options hash of parameters

Options Hash (opts):

• page (Integer) —

  Page of projects to retrieve

• pageSize (Integer) —

  Results per page of results

• sortBy (Integer) —

  Filter to sort queries by

Returns:

• (Hashie::Mash) —

  All active queries

# File 'lib/bwapi/client/admin.rb', line 17

def active_queries opts={}
  get "admin/activequeries", opts
end

#sharing_report ⇒ Hashie::Mash

Get the project report of sharing details

Returns:

• (Hashie::Mash) —

  Project sharing report

# File 'lib/bwapi/client/admin.rb', line 24

def sharing_report
  get "admin/sharing-report"
end