Class: Jamf::MacApplication
- Includes:
- Categorizable, Scopable, SelfServable, Sitable, Updatable, VPPable
- Defined in:
- lib/jamf/api/classic/api_objects/mac_application.rb
Overview
This is just a stub for now.
Constant Summary collapse
- RSRC_BASE =
The base for REST resources of this class
'macapplications'.freeze
- RSRC_LIST_KEY =
the hash key used for the JSON list output of all objects in the JSS
:mac_applications
- RSRC_OBJECT_KEY =
The hash key used for the JSON object output. It’s also used in various error messages
:mac_application
- OBJECT_HISTORY_OBJECT_TYPE =
the object type for this object in the object history table. See APIObject#add_object_history_entry
350
- SCOPE_TARGET_KEY =
See Jamf::Scopable
:computers
- CATEGORY_SUBSET =
Where is the Category in the API JSON?
:general
- CATEGORY_DATA_TYPE =
How is the category stored in the API data?
Hash
- SITE_SUBSET =
Where is the Site data in the API JSON?
:general
Instance Attribute Summary collapse
- #assign_vpp_device_based_licenses ⇒ Boolean (also: #vpp_device_based?) included from VPPable
- #bundle_id ⇒ String readonly
-
#icon ⇒ Jamf::Icon?
(also: #self_service_icon)
included
from SelfServable
The icon used in self-service.
-
#in_self_service ⇒ Boolean
(also: #in_self_service?)
included
from SelfServable
readonly
Is this thing available in Self Service?.
- #is_free ⇒ Boolean (also: #free?) readonly
-
#need_to_update ⇒ Boolean
included
from Updatable
readonly
Do we have unsaved changes?.
- #remaining_vpp_licenses ⇒ Integer (also: #vpp_licenses_remaining) included from VPPable readonly
-
#scope ⇒ Object
included
from Scopable
Attribtues.
-
#self_service_categories ⇒ Array<Hash>
included
from SelfServable
readonly
Each Hash has these keys about the category - :id => [Integer] the JSS id of the category - :name => [String] the name of the category.
-
#self_service_description ⇒ String
included
from SelfServable
The verbage that appears in SelfSvc for this item.
-
#self_service_display_name ⇒ String
(also: #self_service_dislay_name)
included
from SelfServable
The name to display in macOS Self Service.
-
#self_service_feature_on_main_page ⇒ Boolean
included
from SelfServable
Only applicable to macOS targets.
-
#self_service_force_users_to_view_description ⇒ Boolean
included
from SelfServable
Should an extra window appear before the user can install the item? (OSX SSvc only).
-
#self_service_install_button_text ⇒ String
included
from SelfServable
defaults to ‘Install’.
-
#self_service_notification_message ⇒ String
included
from SelfServable
The message text of the notification.
-
#self_service_notification_subject ⇒ String
included
from SelfServable
object name.
-
#self_service_notification_type ⇒ Symbol
included
from SelfServable
How should notifications be sent either :ssvc_only or :ssvc_and_nctr.
-
#self_service_notifications_enabled ⇒ Boolean
(also: #self_service_notifications_enabled?)
included
from SelfServable
Should jamf send notifications to self service?.
-
#self_service_reinstall_button_text ⇒ String
included
from SelfServable
defaults to ‘Reinstall’.
-
#self_service_reminder_frequency ⇒ Integer
included
from SelfServable
How often (in days) should reminders be given.
-
#self_service_reminders_enabled ⇒ Boolean
(also: #self_service_reminders_enabled?)
included
from SelfServable
Should self service give reminders by displaying the notification repeatedly?.
-
#self_service_removal_password ⇒ String
included
from SelfServable
readonly
The password needed for removal, in plain text.
-
#self_service_user_removable ⇒ Symbol
included
from SelfServable
One of the keys in PROFILE_REMOVAL_BY_USER.
- #total_vpp_licenses ⇒ Integer (also: #vpp_licenses_total) included from VPPable readonly
- #url ⇒ String readonly
- #used_vpp_licenses ⇒ Integer (also: #vpp_licenses_used) included from VPPable readonly
- #version ⇒ String readonly
- #vpp_admin_account_id ⇒ Integer (also: #vpp_account_id) included from VPPable readonly
- #vpp_codes ⇒ Hash included from VPPable readonly
Instance Method Summary collapse
-
#add_self_service_category(new_cat, display_in: true, feature_in: false) ⇒ void
(also: #set_self_service_category, #change_self_service_category)
included
from SelfServable
Add or change one of the categories for this item in self service.
-
#add_to_self_service ⇒ void
included
from SelfServable
Add this object to self service if not already there.
-
#category=(new_cat) ⇒ void
included
from Categorizable
Change the category of this object.
-
#category_assigned? ⇒ Boolean
(also: #categorized?)
included
from Categorizable
Does this object have a category assigned?.
-
#category_id ⇒ Integer
included
from Categorizable
The id of the category for this object.
-
#category_name ⇒ String
(also: #category)
included
from Categorizable
The name of the category for this object.
-
#category_object ⇒ Jamf::Category
included
from Categorizable
The Jamf::Category instance for this object’s category.
-
#create ⇒ Object
included
from SelfServable
HACK: ity hack hack…
-
#evaluate_new_category(new_cat) ⇒ Array<String, Integer>
included
from Categorizable
Given a category name or id, return the name and id TODO: use APIObject.exist? and/or APIObject.valid_id.
-
#initialize(**args) ⇒ MacApplication
constructor
Constructor.
-
#name=(newname) ⇒ void
included
from Updatable
Change the name of this item Remember to #update to push changes to the server.
-
#parse_scope ⇒ void
included
from Scopable
private
Call this during initialization of objects that have a scope and the scope instance will be created from @init_data.
-
#reinstall_button_text ⇒ Object
Override reinstall_button_text getter.
-
#reinstall_button_text=(_new) ⇒ Object
Override reinstall_button_text setter.
-
#remove_from_self_service ⇒ void
included
from SelfServable
Remove this object from self service if it’s there.
-
#remove_self_service_category(cat) ⇒ void
included
from SelfServable
Remove a category from those for this item in SSvc.
-
#self_service_display_name ⇒ Object
Override self_service_display_name getter.
-
#self_service_display_name=(_newname) ⇒ Object
Override self_service_display_name setter.
-
#self_service_execute_url ⇒ String
included
from SelfServable
The url to view this thing in Self Service.
-
#self_service_payload ⇒ Symbol
included
from SelfServable
What does this object deploy to the device via self service?.
-
#self_service_targets ⇒ Array<Symbol>
included
from SelfServable
What devices types can get this thing in Self Service.
-
#self_service_view_url ⇒ String
included
from SelfServable
The url to view this thing in Self Service.
-
#should_update ⇒ void
included
from Scopable
When the scope changes, it calls this to tell us that an update is needed.
-
#site=(new_site) ⇒ void
included
from Sitable
Change the site of this object.
-
#site_assigned? ⇒ Boolean
included
from Sitable
Does this object have a site assigned?.
-
#site_id ⇒ Integer
included
from Sitable
The id of the site for this object.
-
#site_name ⇒ String
(also: #site)
included
from Sitable
The name of the site for this object.
-
#site_object ⇒ Jamf::Site
included
from Sitable
The Jamf::Site instance for this object’s site.
-
#unset_category ⇒ void
included
from Categorizable
Set the category to nothing.
-
#unset_site ⇒ void
included
from Sitable
Set the site to nothing.
-
#update ⇒ Object
included
from SelfServable
HACK: ity hack hack…
-
#upload(_type, _local_file) ⇒ Object
Alas, SSvc icons are not uploadable via the API for mac apps.
-
#user_removable? ⇒ Boolean?
included
from SelfServable
Can this thing be removed by the user?.
-
#vpp_admin_account_name ⇒ String
(also: #vpp_account_name)
included
from VPPable
The name of the vpp admin acct for this object.
Constructor Details
#initialize(**args) ⇒ MacApplication
Constructor
85 86 87 88 89 90 91 92 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 85 def initialize(**args) super general = @init_data[:general] @version = general[:version] @is_free = general[:is_free] @bundle_id = general[:bundle_id] @url = general[:url] end |
Instance Attribute Details
#assign_vpp_device_based_licenses ⇒ Boolean Also known as: vpp_device_based? Originally defined in module VPPable
#bundle_id ⇒ String (readonly)
77 78 79 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 77 def bundle_id @bundle_id end |
#icon ⇒ Jamf::Icon? Also known as: self_service_icon Originally defined in module SelfServable
Returns The icon used in self-service.
#in_self_service ⇒ Boolean (readonly) Also known as: in_self_service? Originally defined in module SelfServable
Returns Is this thing available in Self Service?.
#is_free ⇒ Boolean (readonly) Also known as: free?
73 74 75 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 73 def is_free @is_free end |
#need_to_update ⇒ Boolean (readonly) Originally defined in module Updatable
Returns do we have unsaved changes?.
#remaining_vpp_licenses ⇒ Integer (readonly) Also known as: vpp_licenses_remaining Originally defined in module VPPable
#self_service_categories ⇒ Array<Hash> (readonly) Originally defined in module SelfServable
Each Hash has these keys about the category
-
:id => [Integer] the JSS id of the category
-
:name => [String] the name of the category
Most objects also include one or both of these keys:
-
:display_in => [Boolean] should the item be displayed in this category in SSvc? (not MobDevConfProfiles)
-
:feature_in => [Boolean] should the item be featured in this category in SSVC? (macOS targets only)
#self_service_description ⇒ String Originally defined in module SelfServable
Returns The verbage that appears in SelfSvc for this item.
#self_service_display_name ⇒ String Also known as: self_service_dislay_name Originally defined in module SelfServable
Returns The name to display in macOS Self Service.
#self_service_feature_on_main_page ⇒ Boolean Originally defined in module SelfServable
Only applicable to macOS targets
#self_service_force_users_to_view_description ⇒ Boolean Originally defined in module SelfServable
Returns Should an extra window appear before the user can install the item? (OSX SSvc only).
#self_service_install_button_text ⇒ String Originally defined in module SelfServable
defaults to ‘Install’
#self_service_notification_message ⇒ String Originally defined in module SelfServable
Returns The message text of the notification.
#self_service_notification_subject ⇒ String Originally defined in module SelfServable
object name.
#self_service_notification_type ⇒ Symbol Originally defined in module SelfServable
Returns How should notifications be sent either :ssvc_only or :ssvc_and_nctr.
#self_service_notifications_enabled ⇒ Boolean Also known as: self_service_notifications_enabled? Originally defined in module SelfServable
Returns Should jamf send notifications to self service?.
#self_service_reinstall_button_text ⇒ String Originally defined in module SelfServable
defaults to ‘Reinstall’
#self_service_reminder_frequency ⇒ Integer Originally defined in module SelfServable
Returns How often (in days) should reminders be given.
#self_service_reminders_enabled ⇒ Boolean Also known as: self_service_reminders_enabled? Originally defined in module SelfServable
Returns Should self service give reminders by displaying the notification repeatedly?.
#self_service_removal_password ⇒ String (readonly) Originally defined in module SelfServable
Returns The password needed for removal, in plain text.
#self_service_user_removable ⇒ Symbol Originally defined in module SelfServable
Returns one of the keys in PROFILE_REMOVAL_BY_USER.
#total_vpp_licenses ⇒ Integer (readonly) Also known as: vpp_licenses_total Originally defined in module VPPable
#url ⇒ String (readonly)
80 81 82 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 80 def url @url end |
#used_vpp_licenses ⇒ Integer (readonly) Also known as: vpp_licenses_used Originally defined in module VPPable
#version ⇒ String (readonly)
70 71 72 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 70 def version @version end |
#vpp_admin_account_id ⇒ Integer (readonly) Also known as: vpp_account_id Originally defined in module VPPable
Instance Method Details
#add_self_service_category(new_cat, display_in: true, feature_in: false) ⇒ void Also known as: set_self_service_category, change_self_service_category Originally defined in module SelfServable
This method returns an undefined value.
Add or change one of the categories for this item in self service
#add_to_self_service ⇒ void Originally defined in module SelfServable
This method returns an undefined value.
Add this object to self service if not already there.
#category=(new_cat) ⇒ void Originally defined in module Categorizable
This method returns an undefined value.
Change the category of this object. Any of the NON_CATEGORIES values will unset the category
#category_assigned? ⇒ Boolean Also known as: categorized? Originally defined in module Categorizable
Does this object have a category assigned?
#category_id ⇒ Integer Originally defined in module Categorizable
The id of the category for this object.
#category_name ⇒ String Also known as: category Originally defined in module Categorizable
The name of the category for this object. For backward compatibility, this is aliased to just ‘category’
#category_object ⇒ Jamf::Category Originally defined in module Categorizable
The Jamf::Category instance for this object’s category
#create ⇒ Object Originally defined in module SelfServable
HACK: ity hack hack… remove when jamf fixes these bugs
#evaluate_new_category(new_cat) ⇒ Array<String, Integer> Originally defined in module Categorizable
Given a category name or id, return the name and id TODO: use APIObject.exist? and/or APIObject.valid_id
#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.
#parse_scope ⇒ void Originally defined in module Scopable
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Call this during initialization of objects that have a scope and the scope instance will be created from @init_data
#reinstall_button_text ⇒ Object
Override reinstall_button_text getter
109 110 111 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 109 def raise Jamf::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.' end |
#reinstall_button_text=(_new) ⇒ Object
Override reinstall_button_text setter
114 115 116 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 114 def (_new) raise Jamf::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.' end |
#remove_from_self_service ⇒ void Originally defined in module SelfServable
This method returns an undefined value.
Remove this object from self service if it’s there.
#remove_self_service_category(cat) ⇒ void Originally defined in module SelfServable
This method returns an undefined value.
Remove a category from those for this item in SSvc
#self_service_display_name ⇒ Object
Override self_service_display_name getter
99 100 101 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 99 def self_service_display_name raise Jamf::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.' end |
#self_service_display_name=(_newname) ⇒ Object
Override self_service_display_name setter
104 105 106 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 104 def self_service_display_name=(_newname) raise Jamf::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.' end |
#self_service_execute_url ⇒ String Originally defined in module SelfServable
Returns The url to view this thing in Self Service.
#self_service_payload ⇒ Symbol Originally defined in module SelfServable
What does this object deploy to the device via self service?
#self_service_targets ⇒ Array<Symbol> Originally defined in module SelfServable
What devices types can get this thing in Self Service
#self_service_view_url ⇒ String Originally defined in module SelfServable
Returns The url to view this thing in Self Service.
#should_update ⇒ void Originally defined in module Scopable
This method returns an undefined value.
When the scope changes, it calls this to tell us that an update is needed.
#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
#site_assigned? ⇒ Boolean Originally defined in module Sitable
Does this object have a site assigned?
#site_id ⇒ Integer Originally defined in module Sitable
The id of the site for this object.
#site_name ⇒ String 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’
#site_object ⇒ Jamf::Site Originally defined in module Sitable
The Jamf::Site instance for this object’s site
#unset_category ⇒ void Originally defined in module Categorizable
This method returns an undefined value.
Set the category to nothing
#unset_site ⇒ void Originally defined in module Sitable
This method returns an undefined value.
Set the site to nothing
#update ⇒ Object Originally defined in module SelfServable
HACK: ity hack hack… remove when jamf fixes these bugs
#upload(_type, _local_file) ⇒ Object
Alas, SSvc icons are not uploadable via the API for mac apps
120 121 122 |
# File 'lib/jamf/api/classic/api_objects/mac_application.rb', line 120 def upload(_type, _local_file) raise Jamf::UnsupportedError, 'The Classic API does not support uploading icons for MacApplications. Please use the Web UI' end |
#user_removable? ⇒ Boolean? Originally defined in module SelfServable
Can this thing be removed by the user?