EnvironmentClient

interface EnvironmentClient

לקוח לגישה לממשקי API שקשורים לסביבה.

משתמשים ב-EnvironmentClientFactory כדי ליצור מכונה.

סיכום

פונקציות ציבוריות
suspend Environment

הפונקציה מחזירה את הערך Environment.
ListenableFuture<Environment>

הפונקציה מחזירה את הערך Environment.
suspend PrepareEnvironmentResponse
@RequiresApi(value = 28)
prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

הכנת סביבת המכשיר.
ListenableFuture<PrepareEnvironmentResponse>
@RequiresApi(value = 28)
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

הכנת סביבת המכשיר.

פונקציות ציבוריות

getEnvironment

@RequiresApi(value = 28)
suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

הפונקציה מחזירה את הערך Environment. הוא עוזר לשולח הקריאה לדעת אם הסביבה מוכנה או לא.

זריקות
java.lang.SecurityException

אם למתקשר אין הרשאה לקרוא ל-API הזה.
com.google.android.managementapi.common.exceptions.ApiLevelException

אם רמת ה-API של המכשיר נמוכה מ-28.
com.google.android.managementapi.common.exceptions.InvalidArgumentException

אם התפקידים המבוקשים לא חוקיים.
com.google.android.managementapi.common.exceptions.InternalException

אם השיחה נכשלה בגלל שגיאה פנימית.

getEnvironmentAsync

@RequiresApi(value = 28)
fun getEnvironmentAsync(request: GetEnvironmentRequest): ListenableFuture<Environment>

הפונקציה מחזירה את הערך Environment. הוא עוזר לשולח הקריאה לדעת אם הסביבה מוכנה או לא.

החזרות
ListenableFuture<Environment>

ListenableFuture שמקיף את התוצאה. אלה יכולים להיות:

  • עתיד מוצלח שעוטף Environment, במקרה של הצלחה.

  • עתיד כושל שמארז SecurityException, אם מבצע הקריאה לא מורשה לקרוא ל-API הזה.

  • עתיד כושל שמארז ApiLevelException, אם רמת ה-API של המכשיר נמוכה מ-28.

  • עתיד כושל שעוטף InvalidArgumentException, אם התפקידים המבוקשים לא תקינים.

  • עתיד כושל שעוטף InternalException, אם הקריאה נכשלה בגלל שגיאה פנימית.

prepareEnvironment

@RequiresApi(value = 28)
suspend fun prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): PrepareEnvironmentResponse

הכנת סביבת המכשיר.

המשתמש מתבקש להתקין את אפליקציית Device Policy ל-Android. המערכת ממשיכה בהתקנה אם המשתמש מאשר את ההנחיה. אחרי ההתקנה המוצלחת, הוא מבצע פעולות כדי לוודא שאפליקציית Device Policy ל-Android מוכנה.

פרמטרים
notificationServiceComponentName: ComponentName?

ה-ComponentName של השירות שמרחיב את NotificationReceiverService. אם הוא מסופק, הוא חייב להיות רכיב תקין ששייך לאפליקציה מבצעת הקריאה, ושהופץ במניפסט. כדי לקבל התראות על אירועים של הכנת סביבה, צריך:

  1. מטמיעים את הממשק EnvironmentListener באפליקציה.

  2. מציינים איך מטפלים באירועים שהתקבלו.

  3. מרחיבים את NotificationReceiverService ומספקים מופע של EnvironmentListener.

  4. מוסיפים את הכיתה המורחבת NotificationReceiverService לקובץ AndroidManifest.xml ומוודאים שהיא מיוצאת.

לדוגמה:

class MyEnvironmentListener : EnvironmentListener {
  override fun onEnvironmentEvent(event: EnvironmentEvent) {
    // Handle the environment event.
  }
}

class MyNotificationReceiverService : NotificationReceiverService() {
  override fun getPrepareEnvironmentListener(): EnvironmentListener? {
    return MyEnvironmentListener()
  }
}
החזרות
PrepareEnvironmentResponse

PrepareEnvironmentResponse שמכיל פרטים על הסטטוס הסופי של הכנת הסביבה.
זריקות
com.google.android.managementapi.common.exceptions.InvalidArgumentException

אם:

  • [notificationServiceComponentName] הוא לא רכיב תקין ששייך לאפליקציה הקוראת, או שהוא לא מיוצא במניפסט.
  • התפקידים המבוקשים לא חוקיים.
com.google.android.managementapi.common.exceptions.ApiLevelException

אם רמת ה-API של המכשיר נמוכה מ-28.
java.lang.SecurityException

אם למתקשר אין הרשאה לקרוא ל-API הזה.

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException אם חבילת Google Play Services לא עדכנית.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException אם לא ניתן להתקין או לעדכן את Android Device Policy והשגיאה לא ניתנת לתיקון.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException אם האפליקציה של מדיניות המכשיר ל-Android נכשלת בהתקנה או בעדכון, והשגיאה ניתנת לתיקון (למשל, הבקשה נכשלה בגלל בעיות זמניות ברשת), אפשר לנסות שוב לשלוח את הבקשה.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException אם המשתמש מסרב להתקין את אפליקציית Android Device Policy.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException אם המשתמש סוגר את מסך ההסכמה להתקנה.
com.google.android.managementapi.common.exceptions.InternalException

אם השיחה נכשלה בגלל שגיאה פנימית.

prepareEnvironmentAsync

@RequiresApi(value = 28)
fun prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): ListenableFuture<PrepareEnvironmentResponse>

הכנת סביבת המכשיר.

המשתמש מתבקש להתקין את אפליקציית Device Policy ל-Android. המערכת ממשיכה בהתקנה אם המשתמש מאשר את ההנחיה. אחרי ההתקנה המוצלחת, הוא מבצע פעולות כדי לוודא שאפליקציית Device Policy ל-Android מוכנה.

פרמטרים
notificationServiceComponentName: ComponentName?

ה-ComponentName של השירות שמרחיב את NotificationReceiverService. אם הוא מסופק, הוא חייב להיות רכיב תקין ששייך לאפליקציה מבצעת הקריאה, ושהמניפסט מייצא אותו. כדי לקבל התראות על אירועים של הכנת סביבה, צריך:

  1. מטמיעים את הממשק EnvironmentListener באפליקציה.

  2. מציינים איך מטפלים באירועים שהתקבלו.

  3. מרחיבים את NotificationReceiverService ומספקים מופע של EnvironmentListener.

  4. מוסיפים את הכיתה המורחבת NotificationReceiverService לקובץ AndroidManifest.xml ומוודאים שהיא מיוצאת.

לדוגמה:

class MyEnvironmentListener : EnvironmentListener {
  override fun onEnvironmentEvent(event: EnvironmentEvent) {
    // Handle the environment event.
  }
}

class MyNotificationReceiverService : NotificationReceiverService() {
  override fun getPrepareEnvironmentListener(): EnvironmentListener? {
    return MyEnvironmentListener()
  }
}
החזרות
ListenableFuture<PrepareEnvironmentResponse>

ListenableFuture שמקיף את התוצאה. יכול להיות

  • עטיפה עתידית מוצלחת של PrepareEnvironmentResponse שמכילה פרטים על הסטטוס הסופי של הכנת הסביבה.

  • עתיד כושל שמקיף InvalidArgumentException אם:

    • [notificationServiceComponentName] הוא לא רכיב תקין ששייך לאפליקציה הקוראת, או שהוא לא מיוצא במניפסט.
    • התפקידים המבוקשים לא חוקיים.

  • ביטוי עתידי כושל שמעטפת ApiLevelException אם רמת ה-API של המכשיר נמוכה מ-28.

  • עתיד כושל שמארז SecurityException, אם מבצע הקריאה לא מורשה לקרוא ל-API הזה.

  • פונקציית עתיד שנכשלה עם עטיפה של GooglePlayServicesAppNotUpdatedException אם חבילת Google Play Services לא עדכנית.

  • פונקציית עתיד נכשלת שמאריכה את AndroidDevicePolicyInstallOrUpdateUnrecoverableException אם ההתקנה או העדכון של Device Policy ל-Android נכשלים ולא ניתן לשחזר את השגיאה.

  • פונקציית future שנכשלת ועוטפת AndroidDevicePolicyInstallOrUpdateRecoverableException אם לא ניתן להתקין או לעדכן את אפליקציית מדיניות המכשיר של Android, והשגיאה ניתנת לתיקון (למשל, הבקשה נכשלה בגלל בעיות זמניות ברשת), כך שניתן לנסות שוב את הבקשה.

  • ביטוי עתידי כושל שמארז AndroidDevicePolicyInstallConsentDeclinedException אם המשתמש מסרב להתקין את אפליקציית Device Policy למכשירי Android.

  • פונקציית עתיד שנכשלה עם עטיפה של AndroidDevicePolicyInstallConsentDismissedException אם המשתמש סוגר את מסך ההסכמה להתקנה.

  • עתיד כושל שעוטף InternalException, אם הקריאה נכשלה בגלל שגיאה פנימית.