מצב ההעברה בפעולות באימייל

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

האפשרות הזו יכולה להיות שימושית מאוד בתרחישים הנפוצים הבאים:

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

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

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

היכולת להעביר מצב באמצעות כתובת URL להמשך היא תכונה חזקה ש-Firebase Auth מספק, ויכולה לשפר משמעותית את חוויית המשתמש.

העברת המצב של כתובת URL להמשך בפעולות באימייל

כדי להעביר בבטחה כתובת URL להמשך, צריך להוסיף את הדומיין של כתובת ה-URL לרשימת ההיתרים במסוף Firebase. כדי לעשות זאת, מוסיפים את הדומיין הזה לרשימת הדומיינים המורשים בכרטיסייה שיטת הכניסה בקטע אימות, אם הוא לא מופיע שם כבר.

צריך לספק מופע של ActionCodeSettings כששולחים אימייל לאיפוס הסיסמה או אימייל לאימות. אפשר ליצור אותו באמצעות הכיתה המשויכת ActionCodeSettings.Builder שמכילה את השיטות הבאות:

שיטה תיאור
setUrl(String url)

הגדרת הקישור (כתובת ה-URL של המצב/המשך) שיש לו משמעויות שונות בהקשרים שונים:

  • כשהמערכת מטפלת בקישור בווידג'טים של פעולות באינטרנט, זהו קישור העומק בפרמטר השאילתה continueUrl.
  • כשהקישור מטופל ישירות באפליקציה, זהו פרמטר השאילתה continueUrl בקישור העומק של הקישור Hosting.
setIOSBundleId(String iOSBundleId) הגדרת מזהה החבילה ל-iOS כדי לעזור ל-Firebase Authentication לקבוע אם צריך ליצור קישור לאינטרנט בלבד או קישור לנייד שייפתח במכשיר של Apple
setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) הגדרת שם החבילה ל-Android כדי לעזור ל-Firebase Authentication לקבוע אם ליצור קישור לאינטרנט בלבד או קישור לנייד שייפתח במכשיר Android
setHandleCodeInApp(boolean status) אם קישור הפעולה באימייל ייפתח קודם באפליקציה לנייד או בקישור לאינטרנט. ברירת המחדל היא false. אם הערך של הפרמטר הזה מוגדר כ-True, הקישור לקוד הפעולה יישלח כקישור אוניברסלי או כקישור לאפליקציה ל-Android, והאפליקציה תפתח אותו אם היא מותקנת. במקרה של תוצאה שלילית, הקוד יישלח קודם לווידג'ט האינטרנט, ואז המשך הפנייה תוביל לאפליקציה אם היא מותקנת.
setLinkDomain(String customDomain) כשמגדירים דומיינים מותאמים אישית של קישורי Hosting לפרויקט, צריך לציין באיזה מהם להשתמש כשהקישור ייפתח על ידי אפליקציה ספציפית לנייד. אחרת, דומיין ברירת המחדל ייבחר באופן אוטומטי (לדוגמה, PROJECT_ID.firebaseapp.com).
setDynamicLinkDomain(String dynamicLinkDomain) הוצא משימוש. אין לציין את הפרמטר הזה.

הדוגמה הבאה ממחישה איך שולחים קישור אימות באימייל שייפתח קודם באפליקציה לנייד. הקישור העומק יכיל את עומס העבודה של כתובת ה-URL להמשך http://www.example.com/verify?uid=1234.

Kotlin

val auth = Firebase.auth
val user = auth.currentUser!!

val url = "http://www.example.com/verify?uid=" + user.uid
val actionCodeSettings = ActionCodeSettings.newBuilder()
    .setUrl(url)
    .setIOSBundleId("com.example.ios")
    // The default for this is populated with the current android package name.
    .setAndroidPackageName("com.example.android", false, null)
    .build()

user.sendEmailVerification(actionCodeSettings)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            Log.d(TAG, "Email sent.")
        }
    }

MainActivity.kt

Java

FirebaseAuth auth = FirebaseAuth.getInstance();
FirebaseUser user = auth.getCurrentUser();

String url = "http://www.example.com/verify?uid=" + user.getUid();
ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
        .setUrl(url)
        .setIOSBundleId("com.example.ios")
        // The default for this is populated with the current android package name.
        .setAndroidPackageName("com.example.android", false, null)
        .build();

user.sendEmailVerification(actionCodeSettings)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                if (task.isSuccessful()) {
                    Log.d(TAG, "Email sent.");
                }
            }
        });

MainActivity.java

Firebase Authentication משתמש ב-Firebase Hosting כששולחים קישור שמיועד לפתיחה באפליקציה לנייד. כדי להשתמש בתכונה הזו, צריך להגדיר קישורי אירוח במסוף Firebase.

  1. הגדרת אפליקציות ל-Android:

    1. אם אתם מתכננים לטפל בקישורים האלה מאפליקציית Android, עליכם לציין את שם החבילה של האפליקציה בהגדרות הפרויקט במסוף Firebase. בנוסף, צריך לספק את SHA-1 ו-SHA-256 של אישור האפליקציה.
    2. תצטרכו גם להגדיר את מסנן הכוונה לקישור העומק בקובץ AndroidManifest.xml.
    3. מידע נוסף זמין במאמר קבלת הוראות לקישור לאירוח ב-Android.

  2. הגדרת אפליקציות ל-iOS:

    1. אם אתם מתכננים לטפל בקישורים האלה מאפליקציית iOS, תצטרכו להגדיר את הדומיין של הקישור Hosting כדומיין משויך ביכולות של האפליקציה.
    2. מידע נוסף זמין במאמר קבלת הוראות לקישור לאירוח ב-iOS.

טיפול בפעולות אימייל באפליקציית אינטרנט

אתם יכולים לציין אם אתם רוצים לטפל בקישור לקוד הפעולה מאפליקציית אינטרנט ואז להפנות אוטומטית לדף אינטרנט אחר או לאפליקציה לנייד אחרת אחרי השלמת הפעולה, בתנאי שהאפליקציה לנייד זמינה. כדי לעשות זאת, קוראים ל-setHandleCodeInApp(false) באובייקט ActionCodeSettings.Builder. אין צורך במזהה חבילת iOS או בשם חבילת Android, אבל אם תספקו אותם, המשתמש יוכל לקבל הפניה לאפליקציה שציינתם אחרי השלמת קוד הפעולה באימייל.

כתובת ה-URL לאינטרנט שמופיעה כאן היא זו שהוגדרה בקטע 'תבניות של פעולות באימייל'. כברירת מחדל, המערכת מקצה חשבון לכל הפרויקטים. במאמר התאמה אישית של שירותי אימייל מוסבר איך להתאים אישית את השירות לטיפול בפעולות אימייל.

במקרה כזה, הקישור בפרמטר השאילתה continueUrl יהיה קישור Hosting שבו עומס העבודה הוא URL שצוין באובייקט ActionCodeSettings.

כשמטפלים בפעולות אימייל כמו אימות אימייל, צריך לנתח את קוד הפעולה מפרמטר השאילתה oobCode מקישורי העומק, ואז להחיל אותו דרך applyActionCode כדי שהשינוי ייכנס לתוקף, כלומר האימייל יאומת.

טיפול בפעולות אימייל באפליקציה לנייד

אתם יכולים לציין אם אתם רוצים לטפל בקישור של קוד הפעולה באפליקציה לנייד קודם, בתנאי שהיא מותקנת. אם הקישור נלחץ ממכשיר שלא תומך באפליקציה לנייד, הוא נפתח בדף אינטרנט במקום זאת. כדי לעשות זאת, צריך לבצע קריאה ל-setHandleCodeInApp(true) באובייקט ActionCodeSettings.Builder. צריך לציין גם את שם החבילה של האפליקציה ל-Android או את מזהה החבילה של האפליקציה ל-iOS.

כתובת ה-URL החלופית לאינטרנט שמשמשת כאן, כשאין אפליקציה לנייד זמינה, היא זו שמוגדרת בקטע 'תבניות של פעולות באימייל'. כברירת מחדל, המערכת מקצה חשבון לכל פרויקט. למידע נוסף על התאמה אישית של בוררי אימייל, ראו התאמה אישית של בוררי אימייל.

במקרה כזה, הקישור לאפליקציה לנייד שיישלח למשתמש יהיה קישור Hosting, ועומס התעבורה שלו יהיה כתובת ה-URL של קוד הפעולה שהוגדרה במסוף, עם הפרמטרים של השאילתה oobCode, ‏ mode, ‏ apiKey ו-continueUrl. הערך השני יהיה הערך המקורי של URL שצוין באובייקט ActionCodeSettings. אפשר להחיל את קוד הפעולה ישירות מאפליקציה לנייד, בדומה לאופן שבו הוא מטופל בתהליך האינטרנט שמתואר בקטע התאמה אישית של שירותי אימייל.

כשמטפלים בפעולות אימייל כמו אימות אימייל, צריך לנתח את קוד הפעולה מפרמטר השאילתה oobCode מקישורי העומק, ואז להחיל אותו דרך applyActionCode כדי שהשינוי ייכנס לתוקף, כלומר האימייל יאומת.