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.



3077
3078
3079
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3077

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) 


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

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:



2859
2860
2861
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2859

def applications
  @applications
end

#baseband_version ⇒ String

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

Returns:

  • (String) 


2864
2865
2866
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2864

def baseband_version
  @baseband_version
end

#bootloader_version ⇒ String

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

Returns:

  • (String) 


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

def bootloader_version
  @bootloader_version
end

#brand ⇒ String

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

Returns:

  • (String) 


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

def brand
  @brand
end

#build_number ⇒ String

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

Returns:

  • (String) 


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

def build_number
  @build_number
end

#default_language ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def developer_options_status
  @developer_options_status
end

#device_compromised_status ⇒ String

The compromised device status. Corresponds to the JSON property deviceCompromisedStatus

Returns:

  • (String) 


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

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) 


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

def device_id
  @device_id
end

#device_password_status ⇒ String

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

Returns:

  • (String) 


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

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


2914
2915
2916
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2914

def email
  @email
end

#encryption_status ⇒ String

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

Returns:

  • (String) 


2919
2920
2921
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2919

def encryption_status
  @encryption_status
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2924
2925
2926
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2924

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) 


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

def first_sync
  @first_sync
end

#hardware ⇒ String

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

Returns:

  • (String) 


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

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) 


2942
2943
2944
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2942

def hardware_id
  @hardware_id
end

#imei ⇒ String

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

Returns:

  • (String) 


2947
2948
2949
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2947

def imei
  @imei
end

#kernel_version ⇒ String

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

Returns:

  • (String) 


2952
2953
2954
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2952

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) 


2958
2959
2960
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2958

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) 


2964
2965
2966
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2964

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) 


2969
2970
2971
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2969

def 
  @managed_account_is_on_owner_profile
end

#manufacturer ⇒ String

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

Returns:

  • (String) 


2975
2976
2977
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2975

def manufacturer
  @manufacturer
end

#meid ⇒ String

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

Returns:

  • (String) 


2980
2981
2982
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2980

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) 


2988
2989
2990
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2988

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


2997
2998
2999
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2997

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) 


3002
3003
3004
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3002

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) 


3010
3011
3012
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3010

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


3015
3016
3017
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3015

def other_accounts_info
  @other_accounts_info
end

#privilege ⇒ String

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

Returns:

  • (String) 


3020
3021
3022
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3020

def privilege
  @privilege
end

#release_version ⇒ String

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

Returns:

  • (String) 


3025
3026
3027
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3025

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) 


3030
3031
3032
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3030

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) 


3035
3036
3037
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3035

def security_patch_level
  @security_patch_level
end

#serial_number ⇒ String

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

Returns:

  • (String) 


3040
3041
3042
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3040

def serial_number
  @serial_number
end

#status ⇒ String

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

Returns:

  • (String) 


3045
3046
3047
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3045

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) 


3050
3051
3052
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3050

def supports_work_profile
  @supports_work_profile
end

#type ⇒ String

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

Returns:

  • (String) 


3056
3057
3058
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3056

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) 


3061
3062
3063
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3061

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) 


3070
3071
3072
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3070

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) 


3075
3076
3077
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3075

def wifi_mac_address
  @wifi_mac_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3082

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