From 85ac96a24b0045ff9fad0f6dd77e873033039401 Mon Sep 17 00:00:00 2001 From: "Lucas.Xu" Date: Wed, 10 Apr 2024 11:07:14 +0800 Subject: [PATCH] chore: add comment for sign_in_with_magic_link --- libs/client-api/src/http.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libs/client-api/src/http.rs b/libs/client-api/src/http.rs index 50ac6150..48813f5e 100644 --- a/libs/client-api/src/http.rs +++ b/libs/client-api/src/http.rs @@ -216,6 +216,12 @@ impl Client { } /// Sign in with magic link + /// + /// User will receive an email with a magic link to sign in. + /// The redirect_to parameter is optional. If provided, the user will be redirected to the specified URL after signing in. + /// If not, the user will be redirected to the appflowy-flutter:// by default + /// + /// The redirect_to should be the scheme of the app, e.g., appflowy-flutter:// #[instrument(level = "debug", skip_all, err)] pub async fn sign_in_with_magic_link( &self,