Class UserModel

Object used to expose the login user information.

Example of usage:

   (window as any).gmfapi.store.user.getProperties().subscribe({
     next: (user: User) => {
       ...
     },
   })

Hierarchy

UserModel

Index

Constructors

constructor

Methods

getEmptyUserProperties getLoginMessage getProperties getState setLoginMessage setUser

Constructors

constructor

new UserModel(): UserModel
Returns UserModel
- Defined in srcapi/store/user.ts:150

Methods

getEmptyUserProperties

getEmptyUserProperties(): User
Returns
an empty user.

Returns User
- Defined in srcapi/store/user.ts:204

getLoginMessage

getLoginMessage(): BehaviorSubject<string>
Returns
The observable login message.

Returns BehaviorSubject<string>
- Defined in srcapi/store/user.ts:173

getProperties

getProperties(): BehaviorSubject<User>
Returns
the observable user's properties.

Returns BehaviorSubject<User>
- Defined in srcapi/store/user.ts:159

getState

getState(): UserState
Returns
the current user state.

Returns UserState
- Defined in srcapi/store/user.ts:166

setLoginMessage

setLoginMessage(messageState: string): void
Set the current login message
Parameters
- messageState: string
  
  The new login message.
Returns void
- Defined in srcapi/store/user.ts:182

setUser

setUser(properties: User, state: UserState): void
Set the current User's properties and state.
Parameters
- properties: User
  
  The new user
- state: UserState
  
  The new state
Returns void
- Defined in srcapi/store/user.ts:192

Class UserModel

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns UserModel

Methods

getEmptyUserProperties

Returns

Returns User

getLoginMessage

Returns

Returns BehaviorSubject<string>

getProperties

Returns

Returns BehaviorSubject<User>

getState

Returns

Returns UserState

setLoginMessage

Parameters

messageState: string

Returns void

setUser

Parameters

properties: User

state: UserState

Returns void

Settings

Member Visibility

Theme