عبور از وضعیت در اقدامات ایمیل

هنگام ارسال اقدامات ایمیل برای بازنشانی رمز عبور یا تأیید ایمیل کاربر، می‌توانید وضعیت را از طریق URL ادامه دهید. این امکان را برای کاربر فراهم می کند تا پس از اتمام عمل به برنامه برگردد. علاوه بر این، می‌توانید تعیین کنید که آیا پیوند اقدام ایمیل به‌جای یک صفحه وب، مستقیماً از یک برنامه تلفن همراه نصب می‌شود یا خیر.

این می تواند در سناریوهای رایج زیر بسیار مفید باشد:

  • کاربری که در حال حاضر وارد سیستم نشده است، ممکن است در تلاش برای دسترسی به محتوایی باشد که کاربر باید وارد سیستم شود. با این حال، کاربر ممکن است رمز عبور خود را فراموش کرده باشد و بنابراین جریان رمز عبور بازنشانی را آغاز کند. در پایان جریان، کاربر انتظار دارد به بخشی از برنامه که می‌خواست به آن دسترسی پیدا کند، برگردد.

  • ممکن است یک برنامه فقط به حساب های تأیید شده دسترسی داشته باشد. به عنوان مثال، یک خبرنامه ممکن است از کاربر بخواهد که ایمیل خود را قبل از عضویت تأیید کند. کاربر جریان تأیید ایمیل را طی می کند و انتظار دارد برای تکمیل اشتراک خود به برنامه برگردد.

  • در موارد دیگر، کاربر ممکن است جریان را از دستگاه تلفن همراه خود شروع کرده باشد و پس از تأیید انتظار داشته باشد که به جای مرورگر به برنامه تلفن همراه خود بازگردد.

داشتن قابلیت انتقال حالت از طریق URL ادامه دهنده، ویژگی قدرتمندی است که Firebase Auth ارائه می کند و می تواند تجربه کاربر را به میزان قابل توجهی افزایش دهد.

عبور URL وضعیت/ادامه در اقدامات ایمیل

برای ارسال ایمن URL ادامه، دامنه URL باید در لیست سفید کنسول Firebase قرار گیرد. این کار در بخش Authentication با افزودن این دامنه به لیست دامنه های مجاز در زبانه روش ورود به سیستم ، در صورتی که قبلاً وجود ندارد، انجام می شود.

هنگام ارسال ایمیل بازنشانی رمز عبور یا ایمیل تأیید، باید یک نمونه ActionCodeSettings ارائه شود. می توان آن را با کلاس ActionCodeSettings.Builder مرتبط ایجاد کرد که حاوی متدهای زیر است:

روش شرح
setUrl(String url)

پیوند (وضعیت/ادامه URL) را تنظیم می کند که در زمینه های مختلف معانی مختلفی دارد:

  • هنگامی که پیوند در ویجت‌های اکشن وب مدیریت می‌شود، این پیوند عمیق در پارامتر query continueUrl است.
  • وقتی پیوند مستقیماً در برنامه مدیریت می‌شود، این پارامتر query continueUrl در پیوند عمیق پیوند پویا است.
setIOSBundleId(String iOSBundleId) شناسه بسته نرم افزاری iOS را تنظیم می کند. در صورت نصب، سعی می شود پیوند را در یک برنامه iOS باز کند. برنامه iOS باید در کنسول ثبت شود.
setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) نام بسته اندروید را تنظیم می کند. با این کار سعی می شود در صورت نصب لینک در یک برنامه اندرویدی باز شود. اگر installIfNotAvailable روی true تنظیم شده باشد، مشخص می‌کند که اگر دستگاه از آن پشتیبانی می‌کند و برنامه قبلاً نصب نشده است، برنامه Android را نصب کنید یا خیر. اگر minimalVersion مشخص شده باشد و نسخه قدیمی‌تری از برنامه نصب شده باشد، کاربر برای ارتقای برنامه به فروشگاه Play منتقل می‌شود. برنامه اندروید باید در کنسول ثبت شود.
setHandleCodeInApp(boolean status) آیا پیوند اقدام ایمیل ابتدا در یک برنامه تلفن همراه باز می شود یا یک پیوند وب. حالت پیش فرض غلط است. وقتی روی true تنظیم شود، پیوند کد اقدام به عنوان پیوند جهانی یا پیوند برنامه Android ارسال می‌شود و در صورت نصب توسط برنامه باز می‌شود. در صورت نادرست، کد ابتدا به ویجت وب ارسال می شود و سپس در صورت نصب به برنامه ادامه می دهد.
setDynamicLinkDomain(String dynamicLinkDomain) دامنه پیوند پویا (یا زیر دامنه) را برای استفاده برای پیوند فعلی تنظیم می کند، اگر قرار است با استفاده از پیوندهای دینامیک Firebase باز شود. از آنجایی که چندین دامنه پیوند پویا را می توان در هر پروژه پیکربندی کرد، این فیلد امکان انتخاب صریح یکی را فراهم می کند. اگر هیچ یک ارائه نشده باشد، اولین دامنه به طور پیش فرض استفاده می شود.

مثال زیر نحوه ارسال یک پیوند تأیید ایمیل را نشان می دهد که ابتدا در یک برنامه تلفن همراه به عنوان پیوند دینامیک Firebase باز می شود (برنامه iOS com.example.ios یا برنامه Android com.example.android ). پیوند عمیق حاوی بار URL ادامه https://www.example.com/?email=user@example.com خواهد بود.

Kotlin+KTX

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.")
        }
    }

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.");
                }
            }
        });

Firebase Auth هنگام ارسال پیوندی که قرار است در یک برنامه تلفن همراه باز شود ، از Firebase Dynamic Links استفاده می کند. برای استفاده از این ویژگی، پیوندهای پویا باید در کنسول Firebase پیکربندی شوند.

  1. فعال کردن Firebase Dynamic Links:

    1. در کنسول Firebase ، بخش Dynamic Links را باز کنید.
    2. اگر هنوز شرایط Dynamic Links را نپذیرفته اید و دامنه Dynamic Links ایجاد نکرده اید، اکنون این کار را انجام دهید.

      اگر قبلاً یک دامنه پیوندهای پویا ایجاد کرده‌اید، به آن توجه داشته باشید. یک دامنه Dynamic Links معمولاً مانند مثال زیر است:

      example.page.link

      هنگامی که برنامه Apple یا Android خود را برای رهگیری پیوند ورودی پیکربندی می کنید، به این مقدار نیاز خواهید داشت.

  2. پیکربندی برنامه های اندروید:

    1. اگر قصد دارید این پیوندها را از برنامه Android خود مدیریت کنید، نام بسته Android باید در تنظیمات پروژه Firebase Console مشخص شود. علاوه بر این، SHA-1 و SHA-256 گواهی درخواست باید ارائه شود.
    2. همچنین باید فیلتر هدف را برای پیوند عمیق موجود در فایل AndroidManifest.xml خود پیکربندی کنید.
    3. برای اطلاعات بیشتر در این مورد، به دستورالعمل‌های دریافت پیوندهای پویا اندروید مراجعه کنید.
  3. پیکربندی برنامه های iOS:

    1. اگر قصد دارید این پیوندها را از برنامه iOS خود مدیریت کنید، شناسه بسته iOS باید در تنظیمات پروژه Firebase Console مشخص شود. علاوه بر این، شناسه App Store و Apple Developer Team ID نیز باید مشخص شود.
    2. همچنین باید دامنه پیوند جهانی FDL را به عنوان یک دامنه مرتبط در قابلیت های برنامه خود پیکربندی کنید.
    3. اگر قصد دارید برنامه خود را در نسخه های iOS 8 و پایین تر توزیع کنید، باید ID بسته iOS خود را به عنوان یک طرح سفارشی برای URL های ورودی تنظیم کنید.
    4. برای اطلاعات بیشتر در این مورد، به دستورالعمل‌های دریافت پیوندهای دینامیک iOS مراجعه کنید.

مدیریت اقدامات ایمیل در یک برنامه وب

می‌توانید تعیین کنید که آیا می‌خواهید ابتدا پیوند کد عمل را از یک برنامه وب مدیریت کنید و سپس پس از تکمیل موفقیت‌آمیز به صفحه وب یا برنامه تلفن همراه دیگر هدایت شوید، مشروط بر اینکه برنامه تلفن همراه در دسترس باشد. این کار با فراخوانی setHandleCodeInApp(false) در شی ActionCodeSettings.Builder انجام می شود. اگرچه شناسه بسته iOS یا نام بسته Android مورد نیاز نیست، ارائه آنها به کاربر این امکان را می دهد که در تکمیل کد اقدام ایمیلی به برنامه مشخص شده بازگردانده شود.

URL وب مورد استفاده در اینجا، همانی است که در بخش الگوهای اقدام ایمیل پیکربندی شده است. یک پیش فرض برای همه پروژه ها ارائه شده است. برای کسب اطلاعات بیشتر در مورد نحوه سفارشی کردن کنترل کننده اقدام ایمیل، به سفارشی سازی کنترل کننده های ایمیل مراجعه کنید.

در این حالت، پیوند درون پارامتر query continueUrl یک پیوند FDL خواهد بود که بارگذاری آن URL مشخص شده در شی ActionCodeSettings است. در حالی که می‌توانید پیوند ورودی از برنامه خود را بدون وابستگی اضافی رهگیری و مدیریت کنید، توصیه می‌کنیم از کتابخانه مشتری FDL برای تجزیه پیوند عمیق برای شما استفاده کنید.

هنگام مدیریت اقدامات ایمیل مانند تأیید ایمیل، کد اقدام از پارامتر query oobCode باید از پیوند عمیق تجزیه شود و سپس از طریق applyActionCode اعمال شود تا تغییر اعمال شود، یعنی ایمیل تأیید شود.

مدیریت اقدامات ایمیل در یک برنامه تلفن همراه

می‌توانید تعیین کنید که آیا می‌خواهید ابتدا پیوند کد عمل را در برنامه تلفن همراه خود مدیریت کنید، مشروط بر اینکه نصب شده باشد. در برنامه های اندروید، شما همچنین می توانید از طریق installIfNotAvailable تعیین کنید که اگر دستگاه از آن پشتیبانی می کند و قبلاً نصب نشده است، نصب شود. اگر روی پیوند از دستگاهی که از برنامه تلفن همراه پشتیبانی نمی کند کلیک شود، به جای آن از یک صفحه وب باز می شود. این کار با فراخوانی setHandleCodeInApp(true) در شی ActionCodeSettings.Builder انجام می شود. نام بسته Android یا شناسه بسته iOS برنامه تلفن همراه نیز باید مشخص شود.

URL وب بازگشتی که در اینجا استفاده می شود، زمانی که هیچ برنامه تلفن همراه در دسترس نیست، همانی است که در بخش الگوهای اقدام ایمیل پیکربندی شده است. یک پیش فرض برای همه پروژه ها ارائه شده است. برای کسب اطلاعات بیشتر در مورد نحوه سفارشی کردن کنترل کننده اقدام ایمیل، به سفارشی سازی کنترل کننده های ایمیل مراجعه کنید.

در این حالت، پیوند برنامه تلفن همراه ارسال شده به کاربر، یک پیوند FDL خواهد بود که بارگذاری آن URL کد اقدام است که در کنسول پیکربندی شده است، با پارامترهای جستجو oobCode ، mode ، apiKey و continueUrl . دومی URL اصلی مشخص شده در شی ActionCodeSettings خواهد بود. در حالی که می‌توانید پیوند ورودی از برنامه خود را بدون وابستگی اضافی رهگیری و مدیریت کنید، توصیه می‌کنیم از کتابخانه مشتری FDL برای تجزیه پیوند عمیق برای شما استفاده کنید. کد اقدام را می توان مستقیماً از یک برنامه تلفن همراه مانند نحوه استفاده از جریان وب شرح داده شده در بخش سفارشی سازی کنترل کننده های ایمیل اعمال کرد.

هنگام مدیریت اقدامات ایمیل مانند تأیید ایمیل، کد اقدام از پارامتر query oobCode باید از پیوند عمیق تجزیه شود و سپس از طریق applyActionCode اعمال شود تا تغییر اعمال شود، یعنی ایمیل تأیید شود.