Class: Jamf::ClientCheckInSettings

Inherits:
SingletonResource show all
Extended by:
ChangeLog
Includes:
ChangeLog
Defined in:
lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb

Overview

The client checkin settings for the Jamf Pro Server

Constant Summary collapse

UPDATABLE =

Constants

true
RSRC_VERSION = 
'v2'.freeze
RSRC_PATH = 
'check-in'.freeze
OBJECT_MODEL = 
{

  # @!attribute checkInFrequency
  #   @return [integer]
  checkInFrequency: {
    class: :integer
  },

  # @!attribute isCreateHooks
  #   @return [Boolean]
  createHooks: {
    class: :boolean
  },

  # @!attribute isHookLog
  #   @return [Boolean]
  hookLog: {
    class: :boolean
  },

  # @!attribute isHookPolicies
  #   @return [Boolean]
  hookPolicies: {
    class: :boolean
  },

  # @!attribute isHookHideRestore
  #   @return [Boolean]
  hookHideRestore: {
    class: :boolean
  },

  # @!attribute isHookMCX
  #   @return [Boolean]
  hookMcx: {
    class: :boolean
  },

  # @!attribute isBackgroundHooks
  #   @return [Boolean]
  backgroundHooks: {
    class: :boolean
  },

  # @!attribute isHookDisplayStatus
  #   @return [Boolean]
  hookDisplayStatus: {
    class: :boolean
  },

  # @!attribute isCreateStartupScript
  #   @return [Boolean]
  createStartupScript: {
    class: :boolean
  },

  # @!attribute isStartupLog
  #   @return [Boolean]
  startupLog: {
    class: :boolean
  },

  # @!attribute isStartupPolicies
  #   @return [Boolean]
  startupPolicies: {
    class: :boolean
  },

  # @!attribute isStartupSSH
  #   @return [Boolean]
  startupSsh: {
    class: :boolean
  },

  # @!attribute isStartupMCX
  #   @return [Boolean]
  startupMcx: {
    class: :boolean
  },

  # @!attribute isEnableLocalConfigurationProfiles
  #   @return [Boolean]
  enableLocalConfigurationProfiles: {
    class: :boolean
  }

}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from Jamf::JSONObject

Instance Attribute Details

#checkInFrequency ⇒ integer 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 49

#isBackgroundHooks ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 85

#isCreateHooks ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 55

#isCreateStartupScript ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 97

#isEnableLocalConfigurationProfiles ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 127

#isHookDisplayStatus ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 91

#isHookHideRestore ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 73

#isHookLog ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 61

#isHookMCX ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 79

#isHookPolicies ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 67

#isStartupLog ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 103

#isStartupMCX ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 121

#isStartupPolicies ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 109

#isStartupSSH ⇒ Boolean 




# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 115

Class Method Details

.add_change_log_note(note, cnx: Jamf.cnx) ⇒ void Originally defined in module ChangeLog

This method returns an undefined value.

Add a note to this resource’s change log.

If the change history has been cached already, the cache is flushed after adding the note.

.change_log(sort: nil, filter: nil, paged: nil, page_size: nil, refresh: false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeLogEntry> Originally defined in module ChangeLog

The change and note history for this resource. This is a collection of objects as a sub-resource of some primary resource. As such, retriving the change log returns an array of objects, and can be paged, sorted and filtered.

This method is very similar to CollectionResource.all, see the docs for that method for more details

successive page.

.change_log_count(cnx: Jamf.cnx) ⇒ Integer Originally defined in module ChangeLog

how many change log entries are there? needed when using paged #change_log calls

.next_page_of_change_log ⇒ Array<Jamf::ChangeHistoryEntry> Originally defined in module ChangeLog

Fetch the next page of a paged #change_log request Returns an empty array if there’s been no paged request or if the last one has no more pages.

Instance Method Details

#add_change_log_note(note, cnx: Jamf.cnx) ⇒ void Originally defined in module ChangeLog

This method returns an undefined value.

Add a note to this resource’s change log.

If the change history has been cached already, the cache is flushed after adding the note.

#change_log(sort: nil, filter: nil, paged: nil, page_size: nil, refresh: false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeLogEntry> Originally defined in module ChangeLog

The change and note history for this resource. This is a collection of objects as a sub-resource of some primary resource. As such, retriving the change log returns an array of objects, and can be paged, sorted and filtered.

This method is very similar to CollectionResource.all, see the docs for that method for more details

successive page.

#change_log_count(cnx: Jamf.cnx) ⇒ Integer Originally defined in module ChangeLog

how many change log entries are there? needed when using paged #change_log calls

#next_page_of_change_log ⇒ Array<Jamf::ChangeHistoryEntry> Originally defined in module ChangeLog

Fetch the next page of a paged #change_log request Returns an empty array if there’s been no paged request or if the last one has no more pages.