שילוב של הצעות להתקנה מתוך האפליקציה

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

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

הגדרת סביבת הפיתוח

ספריית ההנחיות להתקנה מתוך האפליקציה ב-Play היא חלק מספריות הליבה של Google Play. כדי להשתמש בספרייה, צריך לכלול את התלות הבאה ב-Gradle:

Groovy

// In your app's build.gradle file:
...
dependencies {
    // This dependency is downloaded from the <a href="/studio/build/dependencies#google-maven">Google's Maven repository</a>.
    // So, make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.play:crossdeviceprompt:0.0.1-eap01'
    ...
}

Kotlin

// In your app's build.gradle.kts file:
...
dependencies {
    // This dependency is downloaded from the <a href="/studio/build/dependencies#google-maven">Google's Maven repository</a>.
    // So, make sure you also include that repository in your project's build.gradle file.
    implementation("com.google.android.play:crossdeviceprompt:0.0.1-eap01")
    ...
}

יצירת CrossDevicePromptManager

‫CrossDevicePromptManager הוא הממשק שמאפשר לאפליקציה לבקש מידע ולהפעיל את תהליך ההתקנה. כדי לקבל את המידע הזה, צריך ליצור מכונה:

Kotlin

import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptInfo
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManager
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManagerFactory
import com.google.android.play.core.crossdeviceprompt.model.CrossDevicePromptInstallationRequest

...

val crossDevicePromptManager: CrossDevicePromptManager =
    CrossDevicePromptManagerFactory.create(context)

Java

import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptInfo;
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManager;
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManagerFactory;
import com.google.android.play.core.crossdeviceprompt.model.CrossDevicePromptInstallationRequest;

...

CrossDevicePromptManager crossDevicePromptManager =
    CrossDevicePromptManagerFactory.create(context);

בקשה לאובייקט CrossDevicePromptInstallationRequest

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

1. יצירת CrossDevicePromptInstallationRequest.
2. משתמשים ב-CrossDevicePromptManager כדי ליצור משימת בקשה שמקבלת את הבקשה כפרמטר.

אם המשימה מצליחה, ה-API מחזיר את האובייקט CrossDevicePromptInfo בקריאה החוזרת של ההצלחה. אחרת, ה-API מחזיר את קוד השגיאה Exception בקריאת החזרה (callback) של הכשל.

Kotlin

val request: CrossDevicePromptInstallationRequest? =
    CrossDevicePromptInstallationRequest.create()
val result: Task<CrossDevicePromptInfo?> =
    crossDevicePromptManager.requestInstallationPromptFlow(request)

result.addOnSuccessListener { crossDevicePromptInfo ->
    // Requested a prompt flow successfully
}

result.addOnFailureListener { e ->
    // Failed to request a prompt flow
}

Java

CrossDevicePromptInstallationRequest request =
    CrossDevicePromptInstallationRequest.create();
Task<CrossDevicePromptInfo> result =
    crossDevicePromptManager.requestInstallationPromptFlow(request);

result.addOnSuccessListener(crossDevicePromptInfo -> {
    // Requested a prompt flow successfully
});

result.addOnFailureListener(e -> {
    // Failed to request a prompt flow
});

חשוב: אם מתרחשת שגיאה במהלך תהליך ההתקנה מתוך האפליקציה, אל תעדכנו את המשתמש ואל תשנו את התהליך הרגיל של האפליקציה. אחרי הקריאה ל-onComplete, ממשיכים את התהליך הרגיל של האפליקציה.

כדי לאמת את ההטמעה, אפשר לעיין במאמר בנושא בדיקת הנחיות להתקנת אפליקציות בתוך האפליקציה.