Class: JSS::AdvancedUserSearch

Inherits:

AdvancedSearch

• Object
• APIObject
• AdvancedSearch
• JSS::AdvancedUserSearch

Defined in:

lib/jss/api_object/advanced_search/advanced_user_search.rb,
lib/jss.rb

Overview

An AdvancedUserSearch in the JSS

See Also:

• AdvancedSearch
• APIObject

Constant Summary

RSRC_BASE =

The base for REST resources of this class

'advancedusersearches'.freeze

RSRC_LIST_KEY =

the hash key used for the JSON list output of all objects in the JSS

:advanced_user_searches

RSRC_OBJECT_KEY =

The hash key used for the JSON object output. It’s also used in various error messages

:advanced_user_search

VALID_DATA_KEYS =

these keys, as well as :id and :name, are present in valid API JSON data for this class

[:criteria, :display_fields, :users].freeze

RESULT_CLASS =

what kind of thing is returned by this search?

JSS::User

RESULT_ID_FIELDS =

what data fields come back along with the display fields for each user?

[:id, :name].freeze

Instance Attribute Summary

• #criteria ⇒ JSS::Criteriable::Criteria included from Criteriable

  The criteria for the instance into which we’re mixed.

• #need_to_update ⇒ Boolean included from Updatable readonly

  Do we have unsaved changes?.

Constructor Details

This class inherits a constructor from JSS::AdvancedSearch

Instance Attribute Details

#criteria ⇒ JSS::Criteriable::Criteria Originally defined in module Criteriable

Returns the criteria for the instance into which we’re mixed.

Returns:

• (JSS::Criteriable::Criteria) —

  the criteria for the instance into which we’re mixed.

#need_to_update ⇒ Boolean (readonly) Originally defined in module Updatable

Returns do we have unsaved changes?.

Returns:

• (Boolean) —

  do we have unsaved changes?