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.



2937
2938
2939
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2937

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) 


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

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:



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

def applications
  @applications
end

#baseband_version ⇒ String

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

Returns:

  • (String) 


2724
2725
2726
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2724

def baseband_version
  @baseband_version
end

#bootloader_version ⇒ String

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

Returns:

  • (String) 


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

def bootloader_version
  @bootloader_version
end

#brand ⇒ String

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

Returns:

  • (String) 


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

def brand
  @brand
end

#build_number ⇒ String

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

Returns:

  • (String) 


2739
2740
2741
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2739

def build_number
  @build_number
end

#default_language ⇒ String

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

Returns:

  • (String) 


2744
2745
2746
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2744

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) 


2749
2750
2751
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2749

def developer_options_status
  @developer_options_status
end

#device_compromised_status ⇒ String

The compromised device status. Corresponds to the JSON property deviceCompromisedStatus

Returns:

  • (String) 


2755
2756
2757
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2755

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) 


2761
2762
2763
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2761

def device_id
  @device_id
end

#device_password_status ⇒ String

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

Returns:

  • (String) 


2766
2767
2768
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2766

def device_password_status
  @device_password_status
end

#email ⇒ Array<String>

The list of the 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>) 


2774
2775
2776
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2774

def email
  @email
end

#encryption_status ⇒ String

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

Returns:

  • (String) 


2779
2780
2781
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2779

def encryption_status
  @encryption_status
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2784
2785
2786
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2784

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) 


2790
2791
2792
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2790

def first_sync
  @first_sync
end

#hardware ⇒ String

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

Returns:

  • (String) 


2795
2796
2797
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2795

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) 


2802
2803
2804
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2802

def hardware_id
  @hardware_id
end

#imei ⇒ String

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

Returns:

  • (String) 


2807
2808
2809
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2807

def imei
  @imei
end

#kernel_version ⇒ String

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

Returns:

  • (String) 


2812
2813
2814
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2812

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) 


2818
2819
2820
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2818

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) 


2824
2825
2826
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2824

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) 


2829
2830
2831
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2829

def 
  @managed_account_is_on_owner_profile
end

#manufacturer ⇒ String

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

Returns:

  • (String) 


2835
2836
2837
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2835

def manufacturer
  @manufacturer
end

#meid ⇒ String

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

Returns:

  • (String) 


2840
2841
2842
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2840

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) 


2848
2849
2850
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2848

def model
  @model
end

#name ⇒ Array<String>

The 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>) 


2857
2858
2859
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2857

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) 


2862
2863
2864
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2862

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) 


2870
2871
2872
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2870

def os
  @os
end

#other_accounts_info ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2875
2876
2877
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2875

def other_accounts_info
  @other_accounts_info
end

#privilege ⇒ String

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

Returns:

  • (String) 


2880
2881
2882
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2880

def privilege
  @privilege
end

#release_version ⇒ String

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

Returns:

  • (String) 


2885
2886
2887
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2885

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) 


2890
2891
2892
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2890

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) 


2895
2896
2897
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2895

def security_patch_level
  @security_patch_level
end

#serial_number ⇒ String

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

Returns:

  • (String) 


2900
2901
2902
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2900

def serial_number
  @serial_number
end

#status ⇒ String

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

Returns:

  • (String) 


2905
2906
2907
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2905

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) 


2910
2911
2912
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2910

def supports_work_profile
  @supports_work_profile
end

#type ⇒ String

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

Returns:

  • (String) 


2916
2917
2918
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2916

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) 


2921
2922
2923
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2921

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) 


2930
2931
2932
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2930

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) 


2935
2936
2937
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2935

def wifi_mac_address
  @wifi_mac_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2942

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