Class: Google::Apis::AndroidmanagementV1::Policy

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

Overview

A policy, which governs behavior for a device.

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) ⇒ Policy

Returns a new instance of Policy



1673
1674
1675
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1673

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

Instance Attribute Details

#add_user_disabled ⇒ Boolean Also known as: add_user_disabled?

Whether adding new users and profiles is disabled. Corresponds to the JSON property addUserDisabled

Returns:

  • (Boolean) 


1471
1472
1473
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1471

def add_user_disabled
  @add_user_disabled
end

#adjust_volume_disabled ⇒ Boolean Also known as: adjust_volume_disabled?

Whether adjusting the master volume is disabled. Corresponds to the JSON property adjustVolumeDisabled

Returns:

  • (Boolean) 


1477
1478
1479
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1477

def adjust_volume_disabled
  @adjust_volume_disabled
end

#applications ⇒ Array<Google::Apis::AndroidmanagementV1::ApplicationPolicy>

Policy applied to apps. Corresponds to the JSON property applications

Returns:



1483
1484
1485
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1483

def applications
  @applications
end

#auto_time_required ⇒ Boolean Also known as: auto_time_required?

Whether auto time is required, which prevents the user from manually setting the date and time. Corresponds to the JSON property autoTimeRequired

Returns:

  • (Boolean) 


1489
1490
1491
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1489

def auto_time_required
  @auto_time_required
end

#block_applications_enabled ⇒ Boolean Also known as: block_applications_enabled?

Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. Corresponds to the JSON property blockApplicationsEnabled

Returns:

  • (Boolean) 


1498
1499
1500
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1498

def block_applications_enabled
  @block_applications_enabled
end

#camera_disabled ⇒ Boolean Also known as: camera_disabled?

Whether all cameras on the device are disabled. Corresponds to the JSON property cameraDisabled

Returns:

  • (Boolean) 


1504
1505
1506
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1504

def camera_disabled
  @camera_disabled
end

#compliance_rules ⇒ Array<Google::Apis::AndroidmanagementV1::ComplianceRule>

Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Corresponds to the JSON property complianceRules

Returns:



1513
1514
1515
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1513

def compliance_rules
  @compliance_rules
end

#debugging_features_allowed ⇒ Boolean Also known as: debugging_features_allowed?

Whether the user is allowed to enable debugging features. Corresponds to the JSON property debuggingFeaturesAllowed

Returns:

  • (Boolean) 


1518
1519
1520
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1518

def debugging_features_allowed
  @debugging_features_allowed
end

#default_permission_policy ⇒ String

The default permission policy for requests for runtime permissions. Corresponds to the JSON property defaultPermissionPolicy

Returns:

  • (String) 


1524
1525
1526
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1524

def default_permission_policy
  @default_permission_policy
end

#factory_reset_disabled ⇒ Boolean Also known as: factory_reset_disabled?

Whether factory resetting from settings is disabled. Corresponds to the JSON property factoryResetDisabled

Returns:

  • (Boolean) 


1529
1530
1531
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1529

def factory_reset_disabled
  @factory_reset_disabled
end

#frp_admin_emails ⇒ Array<String>

Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device will not provide factory reset protection. Corresponds to the JSON property frpAdminEmails

Returns:

  • (Array<String>) 


1538
1539
1540
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1538

def frp_admin_emails
  @frp_admin_emails
end

#fun_disabled ⇒ Boolean Also known as: fun_disabled?

Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled. Corresponds to the JSON property funDisabled

Returns:

  • (Boolean) 


1544
1545
1546
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1544

def fun_disabled
  @fun_disabled
end

#install_unknown_sources_allowed ⇒ Boolean Also known as: install_unknown_sources_allowed?

Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources. Corresponds to the JSON property installUnknownSourcesAllowed

Returns:

  • (Boolean) 


1551
1552
1553
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1551

def install_unknown_sources_allowed
  @install_unknown_sources_allowed
end

#keyguard_disabled ⇒ Boolean Also known as: keyguard_disabled?

Whether the keyguard is disabled. Corresponds to the JSON property keyguardDisabled

Returns:

  • (Boolean) 


1557
1558
1559
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1557

def keyguard_disabled
  @keyguard_disabled
end

#maximum_time_to_lock ⇒ Fixnum

Maximum time in milliseconds for user activity until the device will lock. A value of 0 means there is no restriction. Corresponds to the JSON property maximumTimeToLock

Returns:

  • (Fixnum) 


1564
1565
1566
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1564

def maximum_time_to_lock
  @maximum_time_to_lock
end

#modify_accounts_disabled ⇒ Boolean Also known as: modify_accounts_disabled?

Whether adding or removing accounts is disabled. Corresponds to the JSON property modifyAccountsDisabled

Returns:

  • (Boolean) 


1569
1570
1571
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1569

def modify_accounts_disabled
  @modify_accounts_disabled
end

#name ⇒ String

The name of the policy in the form enterprises/enterpriseId/policies/ policyId Corresponds to the JSON property name

Returns:

  • (String) 


1576
1577
1578
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1576

def name
  @name
end

#network_escape_hatch_enabled ⇒ Boolean Also known as: network_escape_hatch_enabled?

Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings. Corresponds to the JSON property networkEscapeHatchEnabled

Returns:

  • (Boolean) 


1587
1588
1589
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1587

def network_escape_hatch_enabled
  @network_escape_hatch_enabled
end

#open_network_configuration ⇒ Hash<String,Object>

Network configuration for the device. See configure networks for more information. Corresponds to the JSON property openNetworkConfiguration

Returns:

  • (Hash<String,Object>) 


1594
1595
1596
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1594

def open_network_configuration
  @open_network_configuration
end

#password_requirements ⇒ Google::Apis::AndroidmanagementV1::PasswordRequirements

Requirements for the password used to unlock a device. Corresponds to the JSON property passwordRequirements

Returns:



1599
1600
1601
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1599

def password_requirements
  @password_requirements
end

#persistent_preferred_activities ⇒ Array<Google::Apis::AndroidmanagementV1::PersistentPreferredActivity>

Default intent handler activities. Corresponds to the JSON property persistentPreferredActivities

Returns:



1604
1605
1606
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1604

def persistent_preferred_activities
  @persistent_preferred_activities
end

#remove_user_disabled ⇒ Boolean Also known as: remove_user_disabled?

Whether removing other users is disabled. Corresponds to the JSON property removeUserDisabled

Returns:

  • (Boolean) 


1609
1610
1611
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1609

def remove_user_disabled
  @remove_user_disabled
end

#safe_boot_disabled ⇒ Boolean Also known as: safe_boot_disabled?

Whether rebooting the device into safe boot is disabled. Corresponds to the JSON property safeBootDisabled

Returns:

  • (Boolean) 


1615
1616
1617
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1615

def safe_boot_disabled
  @safe_boot_disabled
end

#screen_capture_disabled ⇒ Boolean Also known as: screen_capture_disabled?

Whether screen capture is disabled. Corresponds to the JSON property screenCaptureDisabled

Returns:

  • (Boolean) 


1621
1622
1623
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1621

def screen_capture_disabled
  @screen_capture_disabled
end

#status_bar_disabled ⇒ Boolean Also known as: status_bar_disabled?

Whether the status bar is disabled. This disables notifications, quick settings and other screen overlays that allow escape from full-screen mode. Corresponds to the JSON property statusBarDisabled

Returns:

  • (Boolean) 


1628
1629
1630
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1628

def status_bar_disabled
  @status_bar_disabled
end

#status_reporting_settings ⇒ Google::Apis::AndroidmanagementV1::StatusReportingSettings

Settings controlling the behavior of status reports. Corresponds to the JSON property statusReportingSettings

Returns:



1634
1635
1636
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1634

def status_reporting_settings
  @status_reporting_settings
end

#stay_on_plugged_modes ⇒ Array<String>

The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clear maximum_time_to_lock so that the device doesn't lock itself while it stays on. Corresponds to the JSON property stayOnPluggedModes

Returns:

  • (Array<String>) 


1641
1642
1643
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1641

def stay_on_plugged_modes
  @stay_on_plugged_modes
end

#system_update ⇒ Google::Apis::AndroidmanagementV1::SystemUpdate

Configuration for managing system updates Corresponds to the JSON property systemUpdate

Returns:



1646
1647
1648
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1646

def system_update
  @system_update
end

#unmute_microphone_disabled ⇒ Boolean Also known as: unmute_microphone_disabled?

Whether the microphone is muted and adjusting microphone volume is disabled. Corresponds to the JSON property unmuteMicrophoneDisabled

Returns:

  • (Boolean) 


1651
1652
1653
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1651

def unmute_microphone_disabled
  @unmute_microphone_disabled
end

#version ⇒ Fixnum

The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


1658
1659
1660
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1658

def version
  @version
end

#wifi_config_disabled ⇒ Boolean Also known as: wifi_config_disabled?

Whether configuring WiFi access points is disabled. Corresponds to the JSON property wifiConfigDisabled

Returns:

  • (Boolean) 


1663
1664
1665
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1663

def wifi_config_disabled
  @wifi_config_disabled
end

#wifi_configs_lockdown_enabled ⇒ Boolean Also known as: wifi_configs_lockdown_enabled?

Whether WiFi networks defined in Open Network Configuration are locked so they cannot be edited by the user. Corresponds to the JSON property wifiConfigsLockdownEnabled

Returns:

  • (Boolean) 


1670
1671
1672
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1670

def wifi_configs_lockdown_enabled
  @wifi_configs_lockdown_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1678

def update!(**args)
  @add_user_disabled = args[:add_user_disabled] if args.key?(:add_user_disabled)
  @adjust_volume_disabled = args[:adjust_volume_disabled] if args.key?(:adjust_volume_disabled)
  @applications = args[:applications] if args.key?(:applications)
  @auto_time_required = args[:auto_time_required] if args.key?(:auto_time_required)
  @block_applications_enabled = args[:block_applications_enabled] if args.key?(:block_applications_enabled)
  @camera_disabled = args[:camera_disabled] if args.key?(:camera_disabled)
  @compliance_rules = args[:compliance_rules] if args.key?(:compliance_rules)
  @debugging_features_allowed = args[:debugging_features_allowed] if args.key?(:debugging_features_allowed)
  @default_permission_policy = args[:default_permission_policy] if args.key?(:default_permission_policy)
  @factory_reset_disabled = args[:factory_reset_disabled] if args.key?(:factory_reset_disabled)
  @frp_admin_emails = args[:frp_admin_emails] if args.key?(:frp_admin_emails)
  @fun_disabled = args[:fun_disabled] if args.key?(:fun_disabled)
  @install_unknown_sources_allowed = args[:install_unknown_sources_allowed] if args.key?(:install_unknown_sources_allowed)
  @keyguard_disabled = args[:keyguard_disabled] if args.key?(:keyguard_disabled)
  @maximum_time_to_lock = args[:maximum_time_to_lock] if args.key?(:maximum_time_to_lock)
  @modify_accounts_disabled = args[:modify_accounts_disabled] if args.key?(:modify_accounts_disabled)
  @name = args[:name] if args.key?(:name)
  @network_escape_hatch_enabled = args[:network_escape_hatch_enabled] if args.key?(:network_escape_hatch_enabled)
  @open_network_configuration = args[:open_network_configuration] if args.key?(:open_network_configuration)
  @password_requirements = args[:password_requirements] if args.key?(:password_requirements)
  @persistent_preferred_activities = args[:persistent_preferred_activities] if args.key?(:persistent_preferred_activities)
  @remove_user_disabled = args[:remove_user_disabled] if args.key?(:remove_user_disabled)
  @safe_boot_disabled = args[:safe_boot_disabled] if args.key?(:safe_boot_disabled)
  @screen_capture_disabled = args[:screen_capture_disabled] if args.key?(:screen_capture_disabled)
  @status_bar_disabled = args[:status_bar_disabled] if args.key?(:status_bar_disabled)
  @status_reporting_settings = args[:status_reporting_settings] if args.key?(:status_reporting_settings)
  @stay_on_plugged_modes = args[:stay_on_plugged_modes] if args.key?(:stay_on_plugged_modes)
  @system_update = args[:system_update] if args.key?(:system_update)
  @unmute_microphone_disabled = args[:unmute_microphone_disabled] if args.key?(:unmute_microphone_disabled)
  @version = args[:version] if args.key?(:version)
  @wifi_config_disabled = args[:wifi_config_disabled] if args.key?(:wifi_config_disabled)
  @wifi_configs_lockdown_enabled = args[:wifi_configs_lockdown_enabled] if args.key?(:wifi_configs_lockdown_enabled)
end