EnvironmentClient

public interface EnvironmentClient


ไคลเอ็นต์เพื่อเข้าถึง API ที่เกี่ยวข้องกับสภาพแวดล้อม

ใช้ EnvironmentClientFactory เพื่อสร้างอินสแตนซ์

สรุป

เมธอดสาธารณะ

abstract @NonNull Environment

แสดงผล Environment

abstract @NonNull ListenableFuture<@NonNull Environment>

แสดงผล Environment

abstract @NonNull PrepareEnvironmentResponse
prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

เตรียมอุปกรณ์โดยตรวจสอบว่าได้ติดตั้งแอป Android Device Policy และพร้อมใช้งานแล้ว

abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>
prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

เตรียมอุปกรณ์โดยตรวจสอบว่าได้ติดตั้งแอป Android Device Policy และพร้อมใช้งานแล้ว

เมธอดสาธารณะ

getEnvironment

abstract @NonNull Environment getEnvironment(@NonNull GetEnvironmentRequest request)

แสดงผล Environment ซึ่งจะช่วยให้ผู้โทรทราบว่าสภาพแวดล้อมพร้อมหรือไม่

ส่ง
com.google.android.managementapi.common.exceptions.InvalidArgumentException

หากบทบาทที่ขอไม่ถูกต้อง หรือหากมีการตั้งค่า extraCapabilities ไว้ในบทบาทใดก็ตาม ผู้ดูแลระบบไอทีจะให้ความสามารถเพิ่มเติมในนโยบายด้านอุปกรณ์ และแอปจะขอไม่ได้

com.google.android.managementapi.common.exceptions.InternalException

หากการโทรล้มเหลวเนื่องจากข้อผิดพลาดภายใน

com.google.android.managementapi.common.exceptions.ApiLevelException

หากระดับ API ของ SDK ของอุปกรณ์ไม่เพียงพอสำหรับบทบาทที่ขอ (ซึ่งอาจเป็นข้อกำหนดระดับ API ขั้นต่ำทั่วไปสำหรับการโทรเอง) {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} ต้องใช้ระดับ API 23 ขึ้นไป บทบาทอื่นๆ ต้องใช้ระดับ API 28 ขึ้นไป

getEnvironmentAsync

abstract @NonNull ListenableFuture<@NonNull Environment> getEnvironmentAsync(@NonNull GetEnvironmentRequest request)

แสดงผล Environment ซึ่งจะช่วยให้ผู้โทรทราบว่าสภาพแวดล้อมพร้อมหรือไม่

การคืนสินค้า
@NonNull ListenableFuture<@NonNull Environment>

ListenableFuture ที่รวมผลลัพธ์ ซึ่งอาจเป็นเพราะสาเหตุต่อไปนี้

  • Future ที่ประสบความสำเร็จซึ่งรวม Environment ไว้ในกรณีที่สำเร็จ

  • Future ที่ล้มเหลวซึ่งรวม InvalidArgumentException ไว้ หากบทบาทที่ขอไม่ถูกต้อง

  • Future ที่ไม่สำเร็จซึ่งรวม InternalException ไว้ หากการเรียกไม่สำเร็จเนื่องจากข้อผิดพลาดภายใน

ส่ง
com.google.android.managementapi.common.exceptions.InvalidArgumentException

หากบทบาทที่ขอมี extraCapabilities ตั้งค่าไว้ ผู้ดูแลระบบไอทีจะให้ความสามารถเพิ่มเติมในนโยบายด้านอุปกรณ์ และแอปจะขอไม่ได้

com.google.android.managementapi.common.exceptions.ApiLevelException

หากระดับ API ของ SDK ของอุปกรณ์ไม่เพียงพอสำหรับบทบาทที่ขอ (ซึ่งอาจเป็นข้อกำหนดระดับ API ขั้นต่ำทั่วไปสำหรับการโทรเอง) {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} ต้องใช้ระดับ API 23 ขึ้นไป บทบาทอื่นๆ ต้องใช้ระดับ API 28 ขึ้นไป

prepareEnvironment

abstract @NonNull PrepareEnvironmentResponse prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

เตรียมอุปกรณ์โดยตรวจสอบว่าได้ติดตั้งแอป Android Device Policy และพร้อมใช้งานแล้ว

ลักษณะการทำงานจะขึ้นอยู่กับบริบท ดังนี้

  • ขั้นตอนการตรวจสอบความน่าเชื่อถือของอุปกรณ์: หากไม่ได้ติดตั้งแอป Android Device Policy ระบบจะแจ้งให้ผู้ใช้ติดตั้ง หากติดตั้งแอปไว้แล้ว ระบบจะอัปเดตแอปโดยไม่มีการแจ้งเตือน

  • ขั้นตอนการลงทะเบียนอุปกรณ์: ติดตั้งแอป Android Device Policy แบบเงียบหากยังไม่ได้ติดตั้ง และตรวจสอบว่าแอปพร้อมใช้งานโดยไม่ต้องมีการโต้ตอบจากผู้ใช้

พารามิเตอร์
ComponentName notificationServiceComponentName

ComponentNameของบริการที่ขยาย NotificationReceiverService หากระบุไว้ คอมโพเนนต์ดังกล่าวต้องเป็นคอมโพเนนต์ที่ถูกต้องซึ่งเป็นของแอปการโทร และส่งออกในไฟล์ Manifest หากต้องการรับการแจ้งเตือนเกี่ยวกับเหตุการณ์การเตรียมสภาพแวดล้อม คุณต้องทำดังนี้

  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()
}
}
การคืนสินค้า
@NonNull PrepareEnvironmentResponse

PrepareEnvironmentResponse ที่มีรายละเอียดเกี่ยวกับสถานะสุดท้ายของการเตรียมสภาพแวดล้อม

ส่ง
com.google.android.managementapi.common.exceptions.InvalidArgumentException

หาก:

  • [notificationServiceComponentName] ไม่ใช่องค์ประกอบที่ถูกต้องซึ่งเป็นของแอปการโทรหรือไม่ได้ส่งออกในไฟล์ Manifest
  • บทบาทที่ขอรวมถึง {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} และไม่มี {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} หรือไม่ขยาย {@code android.app.admin.DeviceAdminReceiver}
  • บทบาทที่ขอไม่ถูกต้อง
  • บทบาทที่ขอมี extraCapabilities ชุด ผู้ดูแลระบบไอทีจะให้ความสามารถเพิ่มเติมในนโยบายด้านอุปกรณ์ และแอปจะขอไม่ได้
SecurityException

หากผู้โทรไม่ได้รับอนุญาตให้เรียกใช้ API นี้

GooglePlayServicesAppNotUpdatedException

หากบริการ Google Play ไม่ใช่เวอร์ชันล่าสุด

AndroidDevicePolicyInstallOrUpdateUnrecoverableException

หาก Android Device Policy ติดตั้งหรืออัปเดตไม่สำเร็จและข้อผิดพลาดไม่สามารถกู้คืนได้

AndroidDevicePolicyInstallOrUpdateRecoverableException

หากติดตั้งหรืออัปเดตแอป Android Device Policy ไม่สำเร็จและข้อผิดพลาดสามารถกู้คืนได้ (เช่น คำขอล้มเหลวเนื่องจากปัญหาเครือข่ายชั่วคราว) คุณจะลองส่งคำขออีกครั้งได้

AndroidDevicePolicyInstallConsentDeclinedException

หากผู้ใช้ปฏิเสธที่จะติดตั้งแอป Android Device Policy

AndroidDevicePolicyInstallConsentDismissedException

หากผู้ใช้ปิดหน้าจอขอความยินยอมในการติดตั้ง

com.google.android.managementapi.common.exceptions.InternalException

หากการโทรล้มเหลวเนื่องจากข้อผิดพลาดภายใน

PlayStoreUpdateUnrecoverableException

หากอัปเดต Play Store ไม่สำเร็จ

com.google.android.managementapi.common.exceptions.ApiLevelException

หากระดับ API ของ SDK ของอุปกรณ์ไม่เพียงพอสำหรับบทบาทที่ขอ (ซึ่งอาจเป็นข้อกำหนดระดับ API ขั้นต่ำทั่วไปสำหรับการเรียกใช้เอง) {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} ต้องใช้ API ระดับ 23 ขึ้นไป บทบาทอื่นๆ ต้องใช้ระดับ API 28 ขึ้นไป

prepareEnvironmentAsync

abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse> prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

เตรียมอุปกรณ์โดยตรวจสอบว่าได้ติดตั้งแอป Android Device Policy และพร้อมใช้งานแล้ว

ลักษณะการทำงานจะขึ้นอยู่กับบริบท ดังนี้

  • ขั้นตอนการตรวจสอบความน่าเชื่อถือของอุปกรณ์: หากไม่ได้ติดตั้งแอป Android Device Policy ระบบจะแจ้งให้ผู้ใช้ติดตั้ง หากติดตั้งแอปไว้แล้ว ระบบจะอัปเดตแอปโดยไม่มีการแจ้งเตือน

  • ขั้นตอนการลงทะเบียนอุปกรณ์: ติดตั้งแอป Android Device Policy แบบเงียบหากยังไม่ได้ติดตั้ง และตรวจสอบว่าแอปพร้อมใช้งานโดยไม่ต้องมีการโต้ตอบจากผู้ใช้

พารามิเตอร์
ComponentName notificationServiceComponentName

ComponentNameของบริการที่ขยาย NotificationReceiverService หากระบุไว้ คอมโพเนนต์ดังกล่าวต้องเป็นคอมโพเนนต์ที่ถูกต้องซึ่งเป็นของแอปการโทร และส่งออกในไฟล์ Manifest หากต้องการรับการแจ้งเตือนเกี่ยวกับเหตุการณ์การเตรียมสภาพแวดล้อม คุณต้องทำดังนี้

  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()
}
}
การคืนสินค้า
@NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>

ListenableFuture ที่รวมผลลัพธ์ ประเภทรายการได้แก่

  • Future ที่ประสบความสำเร็จซึ่งรวม PrepareEnvironmentResponse ที่มีรายละเอียดเกี่ยวกับสถานะสุดท้ายของการเตรียมสภาพแวดล้อม

  • Future ที่ไม่สำเร็จซึ่งรวม InvalidArgumentException ไว้ในกรณีต่อไปนี้

    • [notificationServiceComponentName] ไม่ใช่องค์ประกอบที่ถูกต้องซึ่งเป็นของแอปการโทรหรือไม่ได้ส่งออกในไฟล์ Manifest
    • บทบาทที่ขอไม่ถูกต้อง
    • บทบาทที่ขอรวมถึง {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} และไม่มี {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} หรือไม่ขยาย {@code android.app.admin.DeviceAdminReceiver}
  • Future ที่ล้มเหลวซึ่งรวม SecurityException ไว้ หากผู้โทรไม่ได้รับอนุญาตให้เรียกใช้ API นี้

  • Future ที่ไม่สำเร็จซึ่งรวม GooglePlayServicesAppNotUpdatedException ไว้หากบริการ Google Play ไม่ใช่เวอร์ชันล่าสุด

  • การดำเนินการในอนาคตที่ล้มเหลวซึ่งรวม AndroidDevicePolicyInstallOrUpdateUnrecoverableException ไว้หาก Android Device Policy ติดตั้งหรืออัปเดตไม่สำเร็จและข้อผิดพลาดไม่สามารถกู้คืนได้

  • Future ที่ไม่สำเร็จซึ่งรวม AndroidDevicePolicyInstallOrUpdateRecoverableException ไว้หากแอป Android Device Policy ติดตั้งหรืออัปเดตไม่สำเร็จและข้อผิดพลาดสามารถกู้คืนได้ (เช่น คำขอไม่สำเร็จเนื่องจากปัญหาเครือข่ายชั่วคราว) เพื่อให้ลองส่งคำขออีกครั้งได้

  • การดำเนินการในอนาคตที่ล้มเหลวซึ่งรวม AndroidDevicePolicyInstallConsentDeclinedException ไว้หากผู้ใช้ปฏิเสธที่จะติดตั้งแอปนโยบายด้านอุปกรณ์ Android

  • การดำเนินการในอนาคตที่ล้มเหลวซึ่งรวม AndroidDevicePolicyInstallConsentDismissedException ไว้หากผู้ใช้ปิดหน้าจอขอความยินยอมในการติดตั้ง

  • Future ที่ไม่สำเร็จซึ่งรวม InternalException ไว้ หากการเรียกไม่สำเร็จเนื่องจากข้อผิดพลาดภายใน

  • Future ที่ไม่สำเร็จซึ่งรวม PlayStoreUpdateUnrecoverableException ไว้หากอัปเดต Play Store ไม่สำเร็จ

ส่ง
com.google.android.managementapi.common.exceptions.InvalidArgumentException

หากบทบาทที่ขอมี extraCapabilities ตั้งค่าไว้ ผู้ดูแลระบบไอทีจะให้ความสามารถเพิ่มเติมในนโยบายด้านอุปกรณ์ และแอปจะขอไม่ได้

com.google.android.managementapi.common.exceptions.ApiLevelException

หากระดับ API ของ SDK ของอุปกรณ์ไม่เพียงพอสำหรับบทบาทที่ขอ {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} ต้องใช้ระดับ API 23 ขึ้นไป บทบาทอื่นๆ ต้องใช้ระดับ API 28 ขึ้นไป