Class: Google::Apis::AndroidenterpriseV1::Install

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/androidenterprise_v1/classes.rb,
generated/google/apis/androidenterprise_v1/representations.rb,
generated/google/apis/androidenterprise_v1/representations.rb

Overview

The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails ( for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Install

Returns a new instance of Install.


1117
1118
1119
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1117

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#install_stateString

Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state " installed" means that the app has been installed. This field is read-only. Corresponds to the JSON property installState

Returns:

  • (String)

1103
1104
1105
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1103

def install_state
  @install_state
end

#product_idString

The ID of the product that the install is for. For example, "app:com.google. android.gm". Corresponds to the JSON property productId

Returns:

  • (String)

1109
1110
1111
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1109

def product_id
  @product_id
end

#version_codeFixnum

The version of the installed product. Guaranteed to be set only if the install state is "installed". Corresponds to the JSON property versionCode

Returns:

  • (Fixnum)

1115
1116
1117
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1115

def version_code
  @version_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1122
1123
1124
1125
1126
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1122

def update!(**args)
  @install_state = args[:install_state] if args.key?(:install_state)
  @product_id = args[:product_id] if args.key?(:product_id)
  @version_code = args[:version_code] if args.key?(:version_code)
end