View Source GoogleApi.AndroidEnterprise.V1.Api.Installs (google_api_android_enterprise v0.26.0)

API calls for all endpoints tagged Installs.

Summary

Functions

Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. A successful response indicates that a removal request has been sent to the device. The call will be considered successful even if the app is not present on the device (e.g. it was never installed, or was removed by the user).

Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.

Functions

Link to this function

androidenterprise_installs_delete(connection, enterprise_id, user_id, device_id, install_id, optional_params \\ [], opts \\ [])

View Source
@spec androidenterprise_installs_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. A successful response indicates that a removal request has been sent to the device. The call will be considered successful even if the app is not present on the device (e.g. it was never installed, or was removed by the user).

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • device_id (type: String.t) - The Android ID of the device.
  • install_id (type: String.t) - The ID of the product represented by the install, e.g. "app:com.google.android.gm".
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_installs_get(connection, enterprise_id, user_id, device_id, install_id, optional_params \\ [], opts \\ [])

View Source
@spec androidenterprise_installs_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.Install.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves details of an installation of an app on a device.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • device_id (type: String.t) - The Android ID of the device.
  • install_id (type: String.t) - The ID of the product represented by the install, e.g. "app:com.google.android.gm".
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.Install{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_installs_list(connection, enterprise_id, user_id, device_id, optional_params \\ [], opts \\ [])

View Source
@spec androidenterprise_installs_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.InstallsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the details of all apps installed on the specified device.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • device_id (type: String.t) - The Android ID of the device.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.InstallsListResponse{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_installs_update(connection, enterprise_id, user_id, device_id, install_id, optional_params \\ [], opts \\ [])

View Source
@spec androidenterprise_installs_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.Install.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • device_id (type: String.t) - The Android ID of the device.
  • install_id (type: String.t) - The ID of the product represented by the install, e.g. "app:com.google.android.gm".
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AndroidEnterprise.V1.Model.Install.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.Install{}} on success
  • {:error, info} on failure