Class: JSS::Category

Inherits:
APIObject show all
Includes:
Creatable, Updatable
Defined in:
lib/jss-api/api_object/category.rb,
lib/jss-api.rb

Overview

A Category in the JSS.

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

"categories"
RSRC_LIST_KEY =

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

:categories
RSRC_OBJECT_KEY =

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

:category
VALID_DATA_KEYS =

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

[:priority]
DEFAULT_CATEGORY =

The Default category

"Unknown"
POSSIBLE_PRIORITIES =

The range of possible priorities

1..20
DEFAULT_PRIORITY =

The Default Priority

5

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Category

See JSS::APIObject#initialize



99
100
101
102
103
 
# File 'lib/jss-api/api_object/category.rb', line 99

def initialize(args = {})
  super
  @priority = @init_data[:priority] || DEFAULT_PRIORITY
  
end

Instance Attribute Details

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

Returns do we have unsaved changes?.

Returns:

  • (Boolean) —

    do we have unsaved changes?

#priority ⇒ Integer

Returns the SelfService priority for this category.

Returns:

  • (Integer) —

    the SelfService priority for this category



90
91
92
 
# File 'lib/jss-api/api_object/category.rb', line 90

def priority
  @priority
end

Instance Method Details

#create ⇒ Integer Originally defined in module Creatable

Create a new object in the JSS.

Returns:

  • (Integer) —

    the jss ID of the newly created object

Raises:

#name=(newname) ⇒ void Originally defined in module Updatable

This method returns an undefined value.

Change the name of this item Remember to #update to push changes to the server.

Parameters:

  • newname (String) —

    the new name

Raises:

#update ⇒ Boolean Originally defined in module Updatable

Save changes to the JSS

Returns:

  • (Boolean) —

    success

Raises: