Class: JSS::EBook

Inherits:
APIObject show all
Includes:
Sitable
Defined in:
lib/jss.rb,
lib/jss/api_object/ebook.rb

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'ebooks'.freeze
RSRC_LIST_KEY =

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

:ebooks
RSRC_OBJECT_KEY =

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

:ebook
OBJECT_HISTORY_OBJECT_TYPE =

the object type for this object in the object history table. See APIObject#add_object_history_entry

24
SITE_SUBSET =

Where is the Site data in the API JSON?

:general

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from JSS::APIObject

Instance Method Details

#site=(new_site) ⇒ void Originally defined in module Sitable

This method returns an undefined value.

Change the site of this object. Any of the NON_SITES values will unset the site

Parameters:

  • new_site (Integer, String)

    The new site

Raises:

#site_assigned?Boolean Originally defined in module Sitable

Does this object have a site assigned?

Returns:

  • (Boolean)

    Does this object have a site assigned?

#site_idInteger Originally defined in module Sitable

The id of the site for this object.

Returns:

  • (Integer)

    The id of the site for this object.

#site_nameString Also known as: site Originally defined in module Sitable

The name of the site for this object. For backward compatibility, this is aliased to just 'site'

Returns:

  • (String)

    The name of the site for this object.

#site_objectJSS::Site Originally defined in module Sitable

The JSS::Site instance for this object's site

Returns:

  • (JSS::Site)

    The JSS::Site instance for this object's site

#unset_sitevoid Originally defined in module Sitable

This method returns an undefined value.

Set the site to nothing