Class default

Indexable

[key: string]: any

Index

Constructors

Accessors

authInstance user userInfo

Methods

addProperty clear deleteAccount initiateDeleteAccount login loginWithOTP logout requestLoginOTP setUserInfo setUserInstance syncUserInfoFromCloud

Constructors

constructor

new default(rootStore?: CDF): default
Parameters
- OptionalrootStore: CDF
Returns default
- Defined in src/store/userStore.ts:39

Accessors

authInstance

get authInstance(): null | ESPRMAuth
Returns null | ESPRMAuth
- Defined in src/store/userStore.ts:57
set authInstance(value: null | ESPRMAuth): void
Parameters
- value: null | ESPRMAuth
Returns void
- Defined in src/store/userStore.ts:60

user

get user(): null | ESPRMUser
Returns null | ESPRMUser
- Defined in src/store/userStore.ts:44
set user(value: null | ESPRMUser): void
Parameters
- value: null | ESPRMUser
Returns void
- Defined in src/store/userStore.ts:47

userInfo

get userInfo(): null | ESPRMUserInfo
Returns null | ESPRMUserInfo
- Defined in src/store/userStore.ts:51
set userInfo(value: null | ESPRMUserInfo): void
Parameters
- value: null | ESPRMUserInfo
Returns void
- Defined in src/store/userStore.ts:54

Methods

addProperty

addProperty(propertyName: string, initialValue: any): void
Dynamically adds an observable property to the store.
Parameters
- propertyName: string
  The name of the property to add.
- initialValue: any
  The initial value of the property.
  
  GPT Context: This function allows adding a new observable property to the store dynamically, along with its getter and setter.
Returns void
- Defined in src/store/userStore.ts:240

clear

clear(): void
Resets the user store.

GPT Context: This method resets the user store by clearing the user and userInfo objects, effectively logging out the user.

Returns void
- Defined in src/store/userStore.ts:228

deleteAccount

deleteAccount(verificationCode: string): Promise<undefined | ESPAPIResponse>
Deletes the user's account.

GPT Context: This method deletes the user's account, clears the user and userInfo objects in the store, and resets the device and group stores.
Parameters
- verificationCode: string
Returns Promise<undefined | ESPAPIResponse>
- Defined in src/store/userStore.ts:206

initiateDeleteAccount

initiateDeleteAccount(): Promise<undefined | ESPAPIResponse>
Initiates the account deletion process.

GPT Context: This method initiates the account deletion process by calling the deleteAccount method and handling any necessary pre-deletion logic.

Returns Promise<undefined | ESPAPIResponse>
- Defined in src/store/userStore.ts:191

login(email: string, password: string): Promise<{ success: boolean }>
Parameters
- email: string
- password: string
Returns Promise<{ success: boolean }>
- Defined in src/store/userStore.ts:138

loginWithOTP

loginWithOTP(
userName: string,
verificationCode: string,
): Promise<{ success: boolean }>
Parameters
- userName: string
- verificationCode: string
Returns Promise<{ success: boolean }>
- Defined in src/store/userStore.ts:166

logout

logout(): Promise<
| { success: boolean }
| { description: string; status: string; success: boolean },
>
Logs out the user.

GPT Context: This method logs out the user, clearing the user and userInfo objects in the store.

Returns Promise<
| { success: boolean }
| { description: string; status: string; success: boolean },
>
- Defined in src/store/userStore.ts:121

requestLoginOTP

requestLoginOTP(userName: string): Promise<{ success: boolean }>
Parameters
- userName: string
Returns Promise<{ success: boolean }>
- Defined in src/store/userStore.ts:153

setUserInfo

setUserInfo(userInfo: any): void
Sets the user information in the store.

This method sets the user information in the store, which can be used to track the currently logged-in user's information.
Parameters
- userInfo: any
  The user information to set.
Returns void
- Defined in src/store/userStore.ts:270

setUserInstance

setUserInstance(userInstance: any): Promise<void>
Sets the user instance.
Parameters
- userInstance: any
  The user instance to be set.
  
  GPT Context: This method sets the user instance in the store and fetches the user information associated with the user instance.
Returns Promise<void>
- Defined in src/store/userStore.ts:102

syncUserInfoFromCloud

syncUserInfoFromCloud(): Promise<void>
Synchronizes the user information from the cloud.

This method fetches the latest user information from the cloud and updates the store.

Returns Promise<void>
A promise that resolves when the user information has been synchronized.

Async
- Defined in src/store/userStore.ts:282