Class: Windoo::KillApp

Inherits:

BaseClasses::JSONObject

• Object
• BaseClasses::JSONObject
• Windoo::KillApp

Includes:

Mixins::APICollection

Defined in:

lib/windoo/objects/kill_app.rb

Overview

A class representing an Application that cannot be running when a Patch is installed.

Patches can contain any number of these, and they are accessed using a KillAppManager available from the Patch#killApps method.

Constant Summary

RSRC_PATH =

Constants

'killapps'

CONTAINER_CLASS =

Windoo::Patch

JSON_ATTRIBUTES =

Attributes

{

  # @!attribute killAppId
  # @return [Integer] The id number of this kill app
  killAppId: {
    class: :Integer,
    identifier: :primary,
    do_not_send: true,
    readonly: true
  },

  # @!attribute patchId
  # @return [Integer] The id number of the patch which uses this
  #   kill app
  patchId: {
    class: :Integer,
    do_not_send: true,
    readonly: true
  },

  # @!attribute bundleId
  # @return [String] The bundle id of the app that must be quit
  #   e.g. com.apple.Safari
  bundleId: {
    class: :String,
    required: true
  },

  # @!attribute appName
  # @return [String] The name of the app that must be quit
  appName: {
    class: :String,
    required: true
  }

}

Constants inherited from BaseClasses::JSONObject

BaseClasses::JSONObject::PP_OMITTED_INST_VARS

Instance Attribute Summary

• #appName ⇒ String

  The name of the app that must be quit.

• #bundleId ⇒ String

  The bundle id of the app that must be quit e.g.

• #killAppId ⇒ Integer

  The id number of this kill app.

• #patchId ⇒ Integer

  The id number of the patch which uses this kill app.

Attributes inherited from BaseClasses::JSONObject

#init_data

Method Summary

Methods included from Mixins::APICollection

#==, #cnx, #container, #create_on_server, #delete, #deleted_id, included, #initialize, #pretty_print_instance_variables, #primary_id, #softwareTitle, #update_on_server

Methods inherited from BaseClasses::JSONObject

attribute_already_parsed?, ident_keys, #initialize, json_attributes, json_attributes_parsed, mutable?, parse_json_attributes, #pretty_print_instance_variables, primary_id_key, required_attributes, #to_api, #to_json, validate_attr

Instance Attribute Details

#appName ⇒ String

Returns The name of the app that must be quit.

Returns:

• (String) —

  The name of the app that must be quit

# File 'lib/windoo/objects/kill_app.rb', line 62

#bundleId ⇒ String

Returns The bundle id of the app that must be quit e.g. com.apple.Safari.

Returns:

• (String) —

  The bundle id of the app that must be quit e.g. com.apple.Safari

# File 'lib/windoo/objects/kill_app.rb', line 54

#killAppId ⇒ Integer

Returns The id number of this kill app.

Returns:

• (Integer) —

  The id number of this kill app

# File 'lib/windoo/objects/kill_app.rb', line 36

#patchId ⇒ Integer

Returns The id number of the patch which uses this kill app.

Returns:

• (Integer) —

  The id number of the patch which uses this kill app

# File 'lib/windoo/objects/kill_app.rb', line 45