Recapp Code Reference
Preparing search index...
frontend/src/hooks/state-actor/useLocalUser
useLocalUser
Function useLocalUser
useLocalUser
()
:
{
isLocalUserActorSucceeded
:
boolean
;
localUser
:
|
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
"UID"
>
,
{
name
?:
string
;
type
:
"NAME"
|
"NICKNAME"
|
"ANONYMOUS"
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
|
null
;
localUserActorSend
:
(
message
:
|
{
UserStoreMessage
:
"Create"
}
&
{
value
:
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
"UID"
>
,
{
name
?:
string
;
type
:
"NAME"
|
"NICKNAME"
|
"ANONYMOUS"
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
;
}
|
{
UserStoreMessage
:
"Update"
}
&
{
value
:
Partial
<
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
(...)
>
,
{
name
?:
(...)
|
(...)
;
type
:
(...)
|
(...)
|
(...)
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
,
>
&
{
uid
:
string
&
BRAND
<
"UID"
>
}
;
}
|
{
UserStoreMessage
:
"GetAll"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"SubscribeToCollection"
}
&
{
value
:
string
[]
}
|
{
UserStoreMessage
:
"UnsubscribeFromCollection"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"Get"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"Has"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"SubscribeTo"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"UnsubscribeFrom"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
;
}
|
{
UserStoreMessage
:
"Find"
}
&
{
value
:
{
query
:
string
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
}
;
}
|
{
UserStoreMessage
:
"GetOwn"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"GetRole"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"GetByFingerprint"
}
&
{
value
:
string
}
|
{
UserStoreMessage
:
"GetNames"
}
&
{
value
:
(
string
&
BRAND
<
"UID"
>
)
[]
}
|
{
UserStoreMessage
:
"GetTeachers"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"IsNicknameUnique"
}
&
{
value
:
string
}
|
{
UserStoreMessage
:
"Remove"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
,
)
=>
void
;
}
Returns
{
isLocalUserActorSucceeded
:
boolean
;
localUser
:
|
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
"UID"
>
,
{
name
?:
string
;
type
:
"NAME"
|
"NICKNAME"
|
"ANONYMOUS"
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
|
null
;
localUserActorSend
:
(
message
:
|
{
UserStoreMessage
:
"Create"
}
&
{
value
:
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
"UID"
>
,
{
name
?:
string
;
type
:
"NAME"
|
"NICKNAME"
|
"ANONYMOUS"
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
;
}
|
{
UserStoreMessage
:
"Update"
}
&
{
value
:
Partial
<
{
active
:
boolean
;
archived
?:
Timestamp
;
created
:
Timestamp
;
email
?:
string
;
fingerprint
?:
string
;
initialQuiz
?:
string
;
isTemporary
:
boolean
;
lastLogin
:
Timestamp
;
nickname
?:
string
;
quizUsage
:
Map
<
string
&
BRAND
<
(...)
>
,
{
name
?:
(...)
|
(...)
;
type
:
(...)
|
(...)
|
(...)
}
,
>
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
;
uid
:
string
&
BRAND
<
"UID"
>
;
updated
:
Timestamp
;
username
:
string
;
}
,
>
&
{
uid
:
string
&
BRAND
<
"UID"
>
}
;
}
|
{
UserStoreMessage
:
"GetAll"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"SubscribeToCollection"
}
&
{
value
:
string
[]
}
|
{
UserStoreMessage
:
"UnsubscribeFromCollection"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"Get"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"Has"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"SubscribeTo"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"UnsubscribeFrom"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
;
}
|
{
UserStoreMessage
:
"Find"
}
&
{
value
:
{
query
:
string
;
role
:
"STUDENT"
|
"TEACHER"
|
"ADMIN"
}
;
}
|
{
UserStoreMessage
:
"GetOwn"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"GetRole"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
|
{
UserStoreMessage
:
"GetByFingerprint"
}
&
{
value
:
string
}
|
{
UserStoreMessage
:
"GetNames"
}
&
{
value
:
(
string
&
BRAND
<
"UID"
>
)
[]
}
|
{
UserStoreMessage
:
"GetTeachers"
}
&
{
value
:
{}
}
|
{
UserStoreMessage
:
"IsNicknameUnique"
}
&
{
value
:
string
}
|
{
UserStoreMessage
:
"Remove"
}
&
{
value
:
string
&
BRAND
<
"UID"
>
}
,
)
=>
void
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Recapp Code Reference
Loading...