Interface MagicLinks
-
- All Implemented Interfaces:
public interface MagicLinksMagicLinks interface that encompasses authentication functions as well as other related functionality
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classMagicLinks.AuthParametersData class used for wrapping parameters used with MagicLinks authentication
public interfaceMagicLinks.EmailMagicLinksProvides all possible ways to call EmailMagicLinks endpoints
-
Method Summary
Modifier and Type Method Description abstract StytchResult<IAuthData>authenticate(MagicLinks.AuthParameters parameters)Authenticate a user given a magic link. abstract Unitauthenticate(MagicLinks.AuthParameters parameters, Function1<StytchResult<IAuthData>, Unit> callback)Authenticate a user given a magic link. abstract CompletableFuture<StytchResult<IAuthData>>authenticateCompletable(MagicLinks.AuthParameters parameters)Authenticate a user given a magic link. abstract MagicLinks.EmailMagicLinksgetEmail()Public variable that exposes an instance of EmailMagicLinks -
-
Method Detail
-
authenticate
abstract StytchResult<IAuthData> authenticate(MagicLinks.AuthParameters parameters)
Authenticate a user given a magic link. This endpoint verifies that the magic link token is valid, hasn't expired or been previously used.
- Parameters:
parameters- required to authenticate- Returns:
AuthResponse
-
authenticate
abstract Unit authenticate(MagicLinks.AuthParameters parameters, Function1<StytchResult<IAuthData>, Unit> callback)
Authenticate a user given a magic link. This endpoint verifies that the magic link token is valid, hasn't expired or been previously used.
- Parameters:
parameters- required to authenticatecallback- a callback that receives an AuthResponse
-
authenticateCompletable
abstract CompletableFuture<StytchResult<IAuthData>> authenticateCompletable(MagicLinks.AuthParameters parameters)
Authenticate a user given a magic link. This endpoint verifies that the magic link token is valid, hasn't expired or been previously used.
- Parameters:
parameters- required to authenticate- Returns:
AuthResponse
-
getEmail
abstract MagicLinks.EmailMagicLinks getEmail()
Public variable that exposes an instance of EmailMagicLinks
-
-
-
-