useSessionList()
The useSessionList() hook returns an array of objects that have been registered on the client device.
Returns
- Name
isLoaded- Type
false- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
sessions- Type
undefined- Description
A list of sessions that have been registered on the client device.
- Name
setActive- Type
undefined- Description
A function that sets the active session and/or organization. See the .
Example
Get a list of sessions
The following example uses useSessionList() to get a list of sessions that have been registered on the client device. The sessions property is used to show the number of times the user has visited the page.
import { useSessionList } from '@clerk/clerk-expo'
import { Text, View, TouchableOpacity, ScrollView } from 'react-native'
export default function Home() {
const { isLoaded, sessions } = useSessionList()
if (!isLoaded) {
// Handle loading state
return null
}
return (
<View>
<Text>Welcome back. You've been here {sessions.length} times before.</Text>
</View>
)
}Feedback
Last updated on