Type aliases
AdminUserData
Admin
User
Data
: CurrentUserData & { cancelEmailAddress
?: string; cancelEmailSecret
?: string; emailChangeDate
?: number; group
?: Group & AdminGroupData; groups
?: (Group & AdminGroupData)[]; newEmailAddress
?: string; newEmailSecret
?: string; passwordTemp
?: string; recoverSecret
?: string; recoverSecretDate
?: number; secret
?: string }ClientConfig
ClientConfig: { allowRegistration: boolean; allowUsernameChange: boolean; emailUsernames: boolean; pwRecovery: boolean; regFields: string[]; unverifiedAccess: boolean; userFields: string[]; verifyEmail: boolean }
Type declaration
allowRegistration: boolean
allowUsernameChange: boolean
emailUsernames: boolean
pwRecovery: boolean
regFields: string[]
unverifiedAccess: boolean
userFields: string[]
verifyEmail: boolean
EventType
EventType: "register" | "login" | "logout"
GroupData
Group
Data
: { avatar
?: string; defaultPrimary
?: boolean; defaultSecondary
?: boolean; enabled
?: boolean; groupname
?: string; name
?: string; parent
?: Group & GroupData; unverifiedSecondary
?: boolean }Type declaration
Optional avatar?: string
Optional defaultPrimary?: boolean
Optional defaultSecondary?: boolean
Optional enabled?: boolean
Optional groupname?: string
Optional name?: string
Optional unverifiedSecondary?: boolean
RegistrationDetails
RegistrationDetails: { additionalData?: {}; email?: string; nameFirst?: string; nameLast?: string; password: string; password2: string; phone?: string; username: string; usernameVerified: boolean }
Type declaration
Optional additionalData?: {}
Optional email?: string
Optional nameFirst?: string
Optional nameLast?: string
password: string
password2: string
Optional phone?: string
username: string
usernameVerified: boolean
UserData
UserData: { avatar?: string; enabled?: boolean; name?: string; nameFirst?: string; nameLast?: string; nameMiddle?: string; username?: string }
Type declaration
Optional avatar?: string
Optional enabled?: boolean
Optional name?: string
Optional nameFirst?: string
Optional nameLast?: string
Optional nameMiddle?: string
Optional username?: string
The group's avatar URL. (Use getAvatar() to support Gravatar.)