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.



2288
2289
2290
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2288

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) 


2059
2060
2061
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2059

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:



2070
2071
2072
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2070

def applications
  @applications
end

#baseband_version ⇒ String

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

Returns:

  • (String) 


2075
2076
2077
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2075

def baseband_version
  @baseband_version
end

#bootloader_version ⇒ String

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

Returns:

  • (String) 


2080
2081
2082
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2080

def bootloader_version
  @bootloader_version
end

#brand ⇒ String

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

Returns:

  • (String) 


2085
2086
2087
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2085

def brand
  @brand
end

#build_number ⇒ String

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

Returns:

  • (String) 


2090
2091
2092
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2090

def build_number
  @build_number
end

#default_language ⇒ String

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

Returns:

  • (String) 


2095
2096
2097
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2095

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) 


2100
2101
2102
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2100

def developer_options_status
  @developer_options_status
end

#device_compromised_status ⇒ String

The compromised device status. Corresponds to the JSON property deviceCompromisedStatus

Returns:

  • (String) 


2106
2107
2108
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2106

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) 


2112
2113
2114
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2112

def device_id
  @device_id
end

#device_password_status ⇒ String

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

Returns:

  • (String) 


2117
2118
2119
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2117

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


2125
2126
2127
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2125

def email
  @email
end

#encryption_status ⇒ String

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

Returns:

  • (String) 


2130
2131
2132
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2130

def encryption_status
  @encryption_status
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2135
2136
2137
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2135

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) 


2141
2142
2143
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2141

def first_sync
  @first_sync
end

#hardware ⇒ String

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

Returns:

  • (String) 


2146
2147
2148
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2146

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) 


2153
2154
2155
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2153

def hardware_id
  @hardware_id
end

#imei ⇒ String

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

Returns:

  • (String) 


2158
2159
2160
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2158

def imei
  @imei
end

#kernel_version ⇒ String

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

Returns:

  • (String) 


2163
2164
2165
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2163

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) 


2169
2170
2171
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2169

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) 


2175
2176
2177
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2175

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) 


2180
2181
2182
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2180

def 
  @managed_account_is_on_owner_profile
end

#manufacturer ⇒ String

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

Returns:

  • (String) 


2186
2187
2188
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2186

def manufacturer
  @manufacturer
end

#meid ⇒ String

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

Returns:

  • (String) 


2191
2192
2193
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2191

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) 


2199
2200
2201
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2199

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


2208
2209
2210
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2208

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) 


2213
2214
2215
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2213

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) 


2221
2222
2223
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2221

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


2226
2227
2228
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2226

def other_accounts_info
  @other_accounts_info
end

#privilege ⇒ String

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

Returns:

  • (String) 


2231
2232
2233
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2231

def privilege
  @privilege
end

#release_version ⇒ String

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

Returns:

  • (String) 


2236
2237
2238
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2236

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) 


2241
2242
2243
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2241

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) 


2246
2247
2248
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2246

def security_patch_level
  @security_patch_level
end

#serial_number ⇒ String

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

Returns:

  • (String) 


2251
2252
2253
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2251

def serial_number
  @serial_number
end

#status ⇒ String

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

Returns:

  • (String) 


2256
2257
2258
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2256

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) 


2261
2262
2263
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2261

def supports_work_profile
  @supports_work_profile
end

#type ⇒ String

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

Returns:

  • (String) 


2267
2268
2269
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2267

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) 


2272
2273
2274
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2272

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) 


2281
2282
2283
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2281

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) 


2286
2287
2288
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2286

def wifi_mac_address
  @wifi_mac_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2293

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