Info

File

src/api/ums/umsModule.ts

Implements

IModule

Index

Properties

Public Readonly name
Public Readonly resourceType

Methods

Public changePassword
Public delete
Public deleteUser
Public getConfig
Public getUser
Public init
Public requestResetPassword
Public resetDefault
Public resetPassword
Public select
Public setDefault
Public signIn
Public signUp
Public terminate
Public update

Accessors

basePath

Constructor

constructor()

Properties

Public Readonly name

Type : string

Default value : "users"

Public Readonly resourceType

Default value : ResourceType.Users

Methods

Public changePassword

changePassword(alias: string, oldPassword: string, newPassword: string)

Change password of the authorized user

Parameters :

Name	Type	Optional	Description
alias	`string`	No	Authorization alias
oldPassword	`string`	No
newPassword	`string`	No

Returns : Observable<D>

Public delete

delete()

Delete users from UMS

Example :

ums.delete()
.where(field =&gt; field(&quot;id).isEqualTo(&quot;d463d501-96c3-405c-aa13-4cc28acf26d5&quot;)
.subscribe()

Returns : DeleteQuery<D>

Public deleteUser

deleteUser(alias: string, password: string)

Delete currently authorized user

Parameters :

Name	Type	Optional
alias	`string`	No
password	`string`	No

Returns : Observable<void>

Public getConfig

getConfig()

Return configuration

Returns : literal type

Public getUser

getUser(alias: string)

Fetch currently authorized user

Parameters :

Name	Type	Optional	Description
alias	`string`	No	Authorization alias

Returns : Observable<D>

Public init

init(coreInjector: ReflectiveInjector)

Parameters :

Name	Type	Optional
coreInjector	`ReflectiveInjector`	No

Returns : any

Public requestResetPassword

requestResetPassword(email: string)

Requests a password reset for the given user e-mail. The user should receive an e-mail message with instructions.

Parameters :

Name	Type	Optional	Description
email	`string`	No	The e-mail address of the user to be reset.

Returns : Observable<D>

Public resetDefault

resetDefault()

Returns : void

Public resetPassword

resetPassword(resetToken: string, newPassword: string)

Resets user's password to a new one

Parameters :

Name	Type	Optional	Description
resetToken	`string`	No	The reset token the user received
newPassword	`string`	No	the new password to be set

Returns : Observable<D>

Public select

select()

Select users from UMS

Example :

ums.select().where(
field =&gt; field(&quot;active&quot;).isEqualTo(true)
).subscribe();

Returns : SelectQuery<D>

Public setDefault

setDefault(alias: string)

Parameters :

Name	Type	Optional
alias	`string`	No

Returns : void

Public signIn

signIn(user: IUMSSignInOptions)

Parameters :

Name	Type	Optional
user	`IUMSSignInOptions`	No

Returns : Observable<string>

Public signUp

signUp(credentials: IUMSCredentials, extra: IUMSExtraFields)

Create a new UMS user

Parameters :

Name	Type	Optional	Default value	Description
credentials	`IUMSCredentials`	No		email and password of created user
extra	`IUMSExtraFields`	No	`{}`	optional list of the additional user fields

Returns : Observable<D>

Public terminate

terminate()

Returns : any

Public update

update(record: Partial)

Update users in UMS

Parameters :

Name	Type	Optional	Description
record	`Partial<D>`	No	Object that represent user fields to be updated

Example :

ums.update({ active: false })
.where(field =&gt; field(&quot;email&quot;).isEqualTo(&quot;ilon.mask

Returns : UpdateQuery<D>

Accessors

basePath

getbasePath()

File

Implements

Index

Properties

Methods

Accessors

Constructor

Properties

Methods

Accessors

result-matching ""

No results matching ""