Class: Jamf::OAPISchemas::TeacherSettingsResponse

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::TeacherSettingsResponse

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb

Overview

OAPI Object Model and Enums for: TeacherSettingsResponse

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::TeacherFeatures
- Jamf::OAPISchemas::SafelistedApp

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/teacher-app:GET' needs permissions:
  - Read Teacher App Settings
- '/v1/teacher-app:PUT' needs permissions:
  - Update Teacher App Settings

Constant Summary

OAPI_PROPERTIES =

{

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

  # @!attribute timezoneId
  #   @return [String]
  timezoneId: {
    class: :string
  },

  # @!attribute autoClear
  #   @return [String]
  autoClear: {
    class: :string
  },

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

  # @!attribute displayNameType
  #   @return [String]
  displayNameType: {
    class: :string
  },

  # @!attribute features
  #   @return [Jamf::OAPISchemas::TeacherFeatures]
  features: {
    class: Jamf::OAPISchemas::TeacherFeatures
  },

  # @!attribute safelistedApps
  #   @return [Array<Jamf::OAPISchemas::SafelistedApp>]
  safelistedApps: {
    class: Jamf::OAPISchemas::SafelistedApp,
    multi: true
  }

}

Instance Attribute Summary

• #autoClear ⇒ String
• #displayNameType ⇒ String
• #features ⇒ Jamf::OAPISchemas::TeacherFeatures
• #isEnabled ⇒ Boolean
• #maxRestrictionLengthSeconds ⇒ Integer
• #safelistedApps ⇒ Array<Jamf::OAPISchemas::SafelistedApp>
• #timezoneId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#autoClear ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 85

#displayNameType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 97

#features ⇒ Jamf::OAPISchemas::TeacherFeatures

Returns:

• (Jamf::OAPISchemas::TeacherFeatures)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 103

#isEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 73

#maxRestrictionLengthSeconds ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 91

#safelistedApps ⇒ Array<Jamf::OAPISchemas::SafelistedApp>

Returns:

• (Array<Jamf::OAPISchemas::SafelistedApp>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 109

#timezoneId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/teacher_settings_response.rb', line 79