Interface Sessions
-
- All Implemented Interfaces:
public interface SessionsThe Sessions interface provides methods for authenticating, updating, or revoking sessions, and properties to retrieve the existing session token (opaque or JWT).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSessions.AuthParamsData class used for wrapping parameters used with Sessions authentication
public final classSessions.RevokeParamsData class used for wrapping parameters used with Sessions revocation
-
Method Summary
Modifier and Type Method Description abstract UnitonChange(Function1<StytchObjectInfo<SessionData>, Unit> callback)Assign a callback that will be called when the session data changes abstract SessionDatagetSync()Get the locally persisted session abstract StytchResult<IAuthData>authenticate(Sessions.AuthParams authParams)Authenticates a Session and updates its lifetime by the specified session_duration_minutes. abstract Unitauthenticate(Sessions.AuthParams authParams, Function1<StytchResult<IAuthData>, Unit> callback)Authenticates a Session and updates its lifetime by the specified session_duration_minutes. abstract CompletableFuture<StytchResult<IAuthData>>authenticateCompletable(Sessions.AuthParams authParams)Authenticates a Session and updates its lifetime by the specified session_duration_minutes. abstract StytchResult<BasicData>revoke(Sessions.RevokeParams params)Revoke a Session and immediately invalidate all its tokens. abstract Unitrevoke(Sessions.RevokeParams params, Function1<StytchResult<BasicData>, Unit> callback)Revoke a Session and immediately invalidate all its tokens. abstract CompletableFuture<StytchResult<BasicData>>revokeCompletable(Sessions.RevokeParams params)Revoke a Session and immediately invalidate all its tokens. abstract UnitupdateSession(String sessionToken, String sessionJwt)Updates the current session with a sessionToken and sessionJwt abstract StateFlow<StytchObjectInfo<SessionData>>getOnChange()Exposes a flow of session data abstract StringgetSessionToken()abstract StringgetSessionJwt()-
-
Method Detail
-
onChange
abstract Unit onChange(Function1<StytchObjectInfo<SessionData>, Unit> callback)
Assign a callback that will be called when the session data changes
-
getSync
abstract SessionData getSync()
Get the locally persisted session
-
authenticate
abstract StytchResult<IAuthData> authenticate(Sessions.AuthParams authParams)
Authenticates a Session and updates its lifetime by the specified session_duration_minutes. If the session_duration_minutes is not specified, a Session will not be extended
- Parameters:
authParams- required to authenticate- Returns:
AuthResponse
-
authenticate
abstract Unit authenticate(Sessions.AuthParams authParams, Function1<StytchResult<IAuthData>, Unit> callback)
Authenticates a Session and updates its lifetime by the specified session_duration_minutes. If the session_duration_minutes is not specified, a Session will not be extended
- Parameters:
authParams- required to authenticatecallback- a callback that receives an AuthResponse
-
authenticateCompletable
abstract CompletableFuture<StytchResult<IAuthData>> authenticateCompletable(Sessions.AuthParams authParams)
Authenticates a Session and updates its lifetime by the specified session_duration_minutes. If the session_duration_minutes is not specified, a Session will not be extended
- Parameters:
authParams- required to authenticate- Returns:
AuthResponse
-
revoke
abstract StytchResult<BasicData> revoke(Sessions.RevokeParams params)
Revoke a Session and immediately invalidate all its tokens.
- Parameters:
params- required for revoking a session- Returns:
BaseResponse
-
revoke
abstract Unit revoke(Sessions.RevokeParams params, Function1<StytchResult<BasicData>, Unit> callback)
Revoke a Session and immediately invalidate all its tokens.
- Parameters:
params- required for revoking a sessioncallback- a callback that receives a BaseResponse
-
revokeCompletable
abstract CompletableFuture<StytchResult<BasicData>> revokeCompletable(Sessions.RevokeParams params)
Revoke a Session and immediately invalidate all its tokens.
- Parameters:
params- required for revoking a session- Returns:
BaseResponse
-
updateSession
abstract Unit updateSession(String sessionToken, String sessionJwt)
Updates the current session with a sessionToken and sessionJwt
-
getOnChange
abstract StateFlow<StytchObjectInfo<SessionData>> getOnChange()
Exposes a flow of session data
-
getSessionToken
abstract String getSessionToken()
-
getSessionJwt
abstract String getSessionJwt()
-
-
-
-