chore: add comment for sign_in_with_magic_link

This commit is contained in:
Lucas.Xu 2024-04-10 11:07:14 +08:00
parent 73e4d28500
commit 85ac96a24b
1 changed files with 6 additions and 0 deletions

View File

@ -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,