Class: Google::Apis::AdminDirectoryV1::MobileDevice

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

Overview

Google Workspace Mobile Management includes Android, Google Sync, and iOS devices. For more information about common group mobile device API tasks, see the Developer's Guide.

Defined Under Namespace

Classes: Application

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MobileDevice

Returns a new instance of MobileDevice.



2735
2736
2737
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2735

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

Instance Attribute Details

#adb_status ⇒ Boolean Also known as: adb_status?

Adb (USB debugging) enabled or disabled on device (Read-only) Corresponds to the JSON property adbStatus

Returns:

  • (Boolean) 


2506
2507
2508
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2506

def adb_status
  @adb_status
end

#applications ⇒ Array<Google::Apis::AdminDirectoryV1::MobileDevice::Application>

The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications. Corresponds to the JSON property applications

Returns:



2517
2518
2519
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2517

def applications
  @applications
end

#baseband_version ⇒ String

The device's baseband version. Corresponds to the JSON property basebandVersion

Returns:

  • (String) 


2522
2523
2524
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2522

def baseband_version
  @baseband_version
end

#bootloader_version ⇒ String

Mobile Device Bootloader version (Read-only) Corresponds to the JSON property bootloaderVersion

Returns:

  • (String) 


2527
2528
2529
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2527

def bootloader_version
  @bootloader_version
end

#brand ⇒ String

Mobile Device Brand (Read-only) Corresponds to the JSON property brand

Returns:

  • (String) 


2532
2533
2534
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2532

def brand
  @brand
end

#build_number ⇒ String

The device's operating system build number. Corresponds to the JSON property buildNumber

Returns:

  • (String) 


2537
2538
2539
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2537

def build_number
  @build_number
end

#default_language ⇒ String

The default locale used on the device. Corresponds to the JSON property defaultLanguage

Returns:

  • (String) 


2542
2543
2544
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2542

def default_language
  @default_language
end

#developer_options_status ⇒ Boolean Also known as: developer_options_status?

Developer options enabled or disabled on device (Read-only) Corresponds to the JSON property developerOptionsStatus

Returns:

  • (Boolean) 


2547
2548
2549
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2547

def developer_options_status
  @developer_options_status
end

#device_compromised_status ⇒ String

The compromised device status. Corresponds to the JSON property deviceCompromisedStatus

Returns:

  • (String) 


2553
2554
2555
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2553

def device_compromised_status
  @device_compromised_status
end

#device_id ⇒ String

The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier. Corresponds to the JSON property deviceId

Returns:

  • (String) 


2559
2560
2561
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2559

def device_id
  @device_id
end

#device_password_status ⇒ String

DevicePasswordStatus (Read-only) Corresponds to the JSON property devicePasswordStatus

Returns:

  • (String) 


2564
2565
2566
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2564

def device_password_status
  @device_password_status
end

#email ⇒ Array<String>

List of owner's email addresses. If your application needs the current list of user emails, use the get method. For additional information, see the retrieve a user method. Corresponds to the JSON property email

Returns:

  • (Array<String>) 


2572
2573
2574
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2572

def email
  @email
end

#encryption_status ⇒ String

Mobile Device Encryption Status (Read-only) Corresponds to the JSON property encryptionStatus

Returns:

  • (String) 


2577
2578
2579
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2577

def encryption_status
  @encryption_status
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2582
2583
2584
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2582

def etag
  @etag
end

#first_sync ⇒ DateTime

Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only) Corresponds to the JSON property firstSync

Returns:

  • (DateTime) 


2588
2589
2590
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2588

def first_sync
  @first_sync
end

#hardware ⇒ String

Mobile Device Hardware (Read-only) Corresponds to the JSON property hardware

Returns:

  • (String) 


2593
2594
2595
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2593

def hardware
  @hardware
end

#hardware_id ⇒ String

The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property. Corresponds to the JSON property hardwareId

Returns:

  • (String) 


2600
2601
2602
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2600

def hardware_id
  @hardware_id
end

#imei ⇒ String

The device's IMEI number. Corresponds to the JSON property imei

Returns:

  • (String) 


2605
2606
2607
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2605

def imei
  @imei
end

#kernel_version ⇒ String

The device's kernel version. Corresponds to the JSON property kernelVersion

Returns:

  • (String) 


2610
2611
2612
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2610

def kernel_version
  @kernel_version
end

#kind ⇒ String

The type of the API resource. For Mobiledevices resources, the value is admin# directory#mobiledevice. Corresponds to the JSON property kind

Returns:

  • (String) 


2616
2617
2618
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2616

def kind
  @kind
end

#last_sync ⇒ DateTime

Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) Corresponds to the JSON property lastSync

Returns:

  • (DateTime) 


2622
2623
2624
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2622

def last_sync
  @last_sync
end

#managed_account_is_on_owner_profile ⇒ Boolean Also known as: managed_account_is_on_owner_profile?

Boolean indicating if this account is on owner/primary profile or not. Corresponds to the JSON property managedAccountIsOnOwnerProfile

Returns:

  • (Boolean) 


2627
2628
2629
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2627

def 
  @managed_account_is_on_owner_profile
end

#manufacturer ⇒ String

Mobile Device manufacturer (Read-only) Corresponds to the JSON property manufacturer

Returns:

  • (String) 


2633
2634
2635
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2633

def manufacturer
  @manufacturer
end

#meid ⇒ String

The device's MEID number. Corresponds to the JSON property meid

Returns:

  • (String) 


2638
2639
2640
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2638

def meid
  @meid
end

#model ⇒ String

The mobile device's model name, for example Nexus S. This property can be updated. For more information, see the Developer's Guide. Corresponds to the JSON property model

Returns:

  • (String) 


2646
2647
2648
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2646

def model
  @model
end

#name ⇒ Array<String>

List of the owner's user names. If your application needs the current list of device owner names, use the get method. For more information about retrieving mobile device user information, see the Developer's Guide. Corresponds to the JSON property name

Returns:

  • (Array<String>) 


2655
2656
2657
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2655

def name
  @name
end

#network_operator ⇒ String

Mobile Device mobile or network operator (if available) (Read-only) Corresponds to the JSON property networkOperator

Returns:

  • (String) 


2660
2661
2662
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2660

def network_operator
  @network_operator
end

#os ⇒ String

The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be updated. For more information, see the Developer's Guide. Corresponds to the JSON property os

Returns:

  • (String) 


2668
2669
2670
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2668

def os
  @os
end

#other_accounts_info ⇒ Array<String>

List of accounts added on device (Read-only) Corresponds to the JSON property otherAccountsInfo

Returns:

  • (Array<String>) 


2673
2674
2675
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2673

def other_accounts_info
  @other_accounts_info
end

#privilege ⇒ String

DMAgentPermission (Read-only) Corresponds to the JSON property privilege

Returns:

  • (String) 


2678
2679
2680
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2678

def privilege
  @privilege
end

#release_version ⇒ String

Mobile Device release version version (Read-only) Corresponds to the JSON property releaseVersion

Returns:

  • (String) 


2683
2684
2685
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2683

def release_version
  @release_version
end

#resource_id ⇒ String

The unique ID the API service uses to identify the mobile device. Corresponds to the JSON property resourceId

Returns:

  • (String) 


2688
2689
2690
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2688

def resource_id
  @resource_id
end

#security_patch_level ⇒ Fixnum

Mobile Device Security patch level (Read-only) Corresponds to the JSON property securityPatchLevel

Returns:

  • (Fixnum) 


2693
2694
2695
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2693

def security_patch_level
  @security_patch_level
end

#serial_number ⇒ String

The device's serial number. Corresponds to the JSON property serialNumber

Returns:

  • (String) 


2698
2699
2700
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2698

def serial_number
  @serial_number
end

#status ⇒ String

The device's status. Corresponds to the JSON property status

Returns:

  • (String) 


2703
2704
2705
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2703

def status
  @status
end

#supports_work_profile ⇒ Boolean Also known as: supports_work_profile?

Work profile supported on device (Read-only) Corresponds to the JSON property supportsWorkProfile

Returns:

  • (Boolean) 


2708
2709
2710
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2708

def supports_work_profile
  @supports_work_profile
end

#type ⇒ String

The type of mobile device. Corresponds to the JSON property type

Returns:

  • (String) 


2714
2715
2716
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2714

def type
  @type
end

#unknown_sources_status ⇒ Boolean Also known as: unknown_sources_status?

Unknown sources enabled or disabled on device (Read-only) Corresponds to the JSON property unknownSourcesStatus

Returns:

  • (Boolean) 


2719
2720
2721
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2719

def unknown_sources_status
  @unknown_sources_status
end

#user_agent ⇒ String

Gives information about the device such as os version. This property can be updated. For more information, see the Developer's Guide. Corresponds to the JSON property userAgent

Returns:

  • (String) 


2728
2729
2730
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2728

def user_agent
  @user_agent
end

#wifi_mac_address ⇒ String

The device's MAC address on Wi-Fi networks. Corresponds to the JSON property wifiMacAddress

Returns:

  • (String) 


2733
2734
2735
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2733

def wifi_mac_address
  @wifi_mac_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2740

def update!(**args)
  @adb_status = args[:adb_status] if args.key?(:adb_status)
  @applications = args[:applications] if args.key?(:applications)
  @baseband_version = args[:baseband_version] if args.key?(:baseband_version)
  @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version)
  @brand = args[:brand] if args.key?(:brand)
  @build_number = args[:build_number] if args.key?(:build_number)
  @default_language = args[:default_language] if args.key?(:default_language)
  @developer_options_status = args[:developer_options_status] if args.key?(:developer_options_status)
  @device_compromised_status = args[:device_compromised_status] if args.key?(:device_compromised_status)
  @device_id = args[:device_id] if args.key?(:device_id)
  @device_password_status = args[:device_password_status] if args.key?(:device_password_status)
  @email = args[:email] if args.key?(:email)
  @encryption_status = args[:encryption_status] if args.key?(:encryption_status)
  @etag = args[:etag] if args.key?(:etag)
  @first_sync = args[:first_sync] if args.key?(:first_sync)
  @hardware = args[:hardware] if args.key?(:hardware)
  @hardware_id = args[:hardware_id] if args.key?(:hardware_id)
  @imei = args[:imei] if args.key?(:imei)
  @kernel_version = args[:kernel_version] if args.key?(:kernel_version)
  @kind = args[:kind] if args.key?(:kind)
  @last_sync = args[:last_sync] if args.key?(:last_sync)
  @managed_account_is_on_owner_profile = args[:managed_account_is_on_owner_profile] if args.key?(:managed_account_is_on_owner_profile)
  @manufacturer = args[:manufacturer] if args.key?(:manufacturer)
  @meid = args[:meid] if args.key?(:meid)
  @model = args[:model] if args.key?(:model)
  @name = args[:name] if args.key?(:name)
  @network_operator = args[:network_operator] if args.key?(:network_operator)
  @os = args[:os] if args.key?(:os)
  @other_accounts_info = args[:other_accounts_info] if args.key?(:other_accounts_info)
  @privilege = args[:privilege] if args.key?(:privilege)
  @release_version = args[:release_version] if args.key?(:release_version)
  @resource_id = args[:resource_id] if args.key?(:resource_id)
  @security_patch_level = args[:security_patch_level] if args.key?(:security_patch_level)
  @serial_number = args[:serial_number] if args.key?(:serial_number)
  @status = args[:status] if args.key?(:status)
  @supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile)
  @type = args[:type] if args.key?(:type)
  @unknown_sources_status = args[:unknown_sources_status] if args.key?(:unknown_sources_status)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
  @wifi_mac_address = args[:wifi_mac_address] if args.key?(:wifi_mac_address)
end