Interface RecipeInterface

Hierarchy

RecipeInterface

Index

Methods

Methods

createNewSession

createNewSession(input: { jwtPayload?: any; res: any; sessionData?: any; userId: string }): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/types.ts:162
Parameters
- input: { jwtPayload?: any; res: any; sessionData?: any; userId: string }
  - Optional jwtPayload?: any
  - res: any
  - Optional sessionData?: any
  - userId: string
Returns Promise<SessionContainer>

getAccessTokenLifeTimeMS

getAccessTokenLifeTimeMS(): Promise<number>

- Defined in lib/ts/recipe/session/types.ts:201
Returns Promise<number>

getAllSessionHandlesForUser

getAllSessionHandlesForUser(input: { userId: string }): Promise<string[]>

- Defined in lib/ts/recipe/session/types.ts:185
Parameters
- input: { userId: string }
  - userId: string
Returns Promise<string[]>

getJWTPayload

getJWTPayload(input: { sessionHandle: string }): Promise<any>

- Defined in lib/ts/recipe/session/types.ts:197
deprecated
Use getSessionInformation instead

Parameters
- input: { sessionHandle: string }
  - sessionHandle: string
Returns Promise<any>

getRefreshTokenLifeTimeMS

getRefreshTokenLifeTimeMS(): Promise<number>

- Defined in lib/ts/recipe/session/types.ts:203
Returns Promise<number>

getSession

getSession(input: { options?: VerifySessionOptions; req: any; res: any }): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/types.ts:169
Parameters
- input: { options?: VerifySessionOptions; req: any; res: any }
  - Optional options?: VerifySessionOptions
  - req: any
  - res: any
Returns Promise<undefined | SessionContainer>

getSessionData

getSessionData(input: { sessionHandle: string }): Promise<any>

- Defined in lib/ts/recipe/session/types.ts:192
deprecated
Use getSessionInformation instead

Parameters
- input: { sessionHandle: string }
  - sessionHandle: string
Returns Promise<any>

getSessionInformation

getSessionInformation(input: { sessionHandle: string }): Promise<SessionInformation>

- Defined in lib/ts/recipe/session/types.ts:181
Used to retrieve all session information for a given session handle. Can be used in place of:
- getSessionData
- getJWTPayload
Parameters
- input: { sessionHandle: string }
  - sessionHandle: string
Returns Promise<SessionInformation>

refreshSession

refreshSession(input: { req: any; res: any }): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/types.ts:175
Parameters
- input: { req: any; res: any }
  - req: any
  - res: any
Returns Promise<SessionContainer>

revokeAllSessionsForUser

revokeAllSessionsForUser(input: { userId: string }): Promise<string[]>

- Defined in lib/ts/recipe/session/types.ts:183
Parameters
- input: { userId: string }
  - userId: string
Returns Promise<string[]>

revokeMultipleSessions

revokeMultipleSessions(input: { sessionHandles: string[] }): Promise<string[]>

- Defined in lib/ts/recipe/session/types.ts:189
Parameters
- input: { sessionHandles: string[] }
  - sessionHandles: string[]
Returns Promise<string[]>

revokeSession

revokeSession(input: { sessionHandle: string }): Promise<boolean>

- Defined in lib/ts/recipe/session/types.ts:187
Parameters
- input: { sessionHandle: string }
  - sessionHandle: string
Returns Promise<boolean>

updateJWTPayload

updateJWTPayload(input: { newJWTPayload: any; sessionHandle: string }): Promise<void>

- Defined in lib/ts/recipe/session/types.ts:199
Parameters
- input: { newJWTPayload: any; sessionHandle: string }
  - newJWTPayload: any
  - sessionHandle: string
Returns Promise<void>

updateSessionData

updateSessionData(input: { newSessionData: any; sessionHandle: string }): Promise<void>

- Defined in lib/ts/recipe/session/types.ts:194
Parameters
- input: { newSessionData: any; sessionHandle: string }
  - newSessionData: any
  - sessionHandle: string
Returns Promise<void>

Generated using TypeDoc