Class: Jamf::OAPISchemas::SelfServiceInteractionSettings

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SelfServiceInteractionSettings

Defined in:

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

Overview

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

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.

- Jamf::OAPISchemas::SelfServiceSettings

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

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

Constant Summary

DEFAULT_LANDING_PAGE_OPTIONS =

Enums used by this class or others

[
  'HOME',
  'BROWSE',
  'HISTORY',
  'NOTIFICATIONS'
]

OAPI_PROPERTIES =

{

  # global Self Service setting for if notifications are on or off
  # @!attribute notificationsEnabled
  #   @return [Boolean]
  notificationsEnabled: {
    class: :boolean
  },

  # whether users should be notified they need to approve organization's MDM profile
  # @!attribute alertUserApprovedMdm
  #   @return [Boolean]
  alertUserApprovedMdm: {
    class: :boolean
  },

  # the default landing page in Self Service
  # @!attribute defaultLandingPage
  #   @return [String]
  defaultLandingPage: {
    class: :string,
    enum: DEFAULT_LANDING_PAGE_OPTIONS
  },

  # id for the default home category in Self Service
  # @!attribute defaultHomeCategoryId
  #   @return [Integer]
  defaultHomeCategoryId: {
    class: :integer,
    format: 'int32'
  },

  # renamed string for bookmarks if the admin wishes
  # @!attribute bookmarksName
  #   @return [String]
  bookmarksName: {
    class: :string,
    required: true
  }

}

Instance Attribute Summary

• #alertUserApprovedMdm ⇒ Boolean
• #bookmarksName ⇒ String
• #defaultHomeCategoryId ⇒ Integer
• #defaultLandingPage ⇒ String
• #notificationsEnabled ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#alertUserApprovedMdm ⇒ Boolean

Returns:

• (Boolean)

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

#bookmarksName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_interaction_settings.rb', line 108

#defaultHomeCategoryId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_interaction_settings.rb', line 100

#defaultLandingPage ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_interaction_settings.rb', line 92

#notificationsEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_interaction_settings.rb', line 78