Class RunUser

Hierarchy

TagoIOModule<GenericModuleParams>
- RunUser

Constructors

constructor

new RunUser(params: GenericModuleParams): RunUser

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns RunUser

Properties

SDB

SDB: SDB = ...

Methods

confirmOTP

confirmOTP(tagoIORunURL: string, pinCode: string, typeOTP: OTPType): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:314
Confirm OTP enabling process for a given OTP Type

Parameters
- tagoIORunURL: string
- pinCode: string
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>

delete

delete(tagoIORunURL: string): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:75
Delete Run user info

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
Returns Promise<string>

disableOTP

disableOTP(tagoIORunURL: string, credentials: RunUserCredentials, typeOTP: OTPType): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:299
Enable OTP for a given OTP Type

Parameters
- tagoIORunURL: string
- credentials: RunUserCredentials
  
  Credentials
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>

edit

edit(tagoIORunURL: string, userChangesObj: Partial<RunUserInfo>): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:61
Edit Run user info

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- userChangesObj: Partial<RunUserInfo>
  
  Data to change in user
Returns Promise<string>

enableOTP

enableOTP(tagoIORunURL: string, credentials: RunUserCredentials, typeOTP: OTPType): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:284
Enable OTP for a given OTP Type. You will be requested to confirm the operation with a pin code.

Parameters
- tagoIORunURL: string
- credentials: RunUserCredentials
  
  Credentials
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>

info

info(tagoIORunURL: string): Promise<RunUserInfo>

- Defined in src/modules/RunUser/RunUser.ts:23
Get Run user info

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
Returns Promise<RunUserInfo>

notificationButton

notificationButton(tagoIORunURL: string, notificationID: string, buttonID: string): Promise<any>

- Defined in src/modules/RunUser/RunUser.ts:236
Trigger notification button

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- notificationID: string
  
  TagoIO Run notification id
- buttonID: string
  
  Notification button id
Returns Promise<any>

notificationDelete

notificationDelete(tagoIORunURL: string, notificationID: string): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:250
Delete notification

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- notificationID: string
  
  TagoIO Run notification id
Returns Promise<string>

notificationList

notificationList(tagoIORunURL: string, queryObj?: NotificationQuery): Promise<NotificationInfo[]>

- Defined in src/modules/RunUser/RunUser.ts:163
List notifications.

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- Optional queryObj: NotificationQuery
Returns Promise<NotificationInfo[]>

notificationMarkAllRead

notificationMarkAllRead(tagoIORunURL: string): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:222
Mark all notifications as read

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
Returns Promise<string>

notificationMarkRead

notificationMarkRead(tagoIORunURL: string, notificationIDs: string | string[]): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:179
Mark notification as read

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- notificationIDs: string | string[]
  
  array of notification ids or a single id
Returns Promise<string>

notificationMarkUnread

notificationMarkUnread(tagoIORunURL: string, notificationIDs: string | string[]): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:201
Mark notification as unread

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- notificationIDs: string | string[]
  
  array of notification ids or a single id
Returns Promise<string>

passwordChange

passwordChange(tagoIORunURL: string, password: string): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:147
Change password using token of the password recover.

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- password: string
  
  New password
Returns Promise<string>

Static confirmUser

confirmUser(tagoIORunURL: string, token: string, region?: Regions): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:114
Confirm User on TagoIO Run (Anonymous)

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- token: string
  
  TagoIO Run user token
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>

Static create

create(tagoIORunURL: string, newUserObj: RunUserCreateInfo, region?: Regions): Promise<RunUserCreate>

- Defined in src/modules/RunUser/RunUser.ts:40
Create new TagoIO Run User (Anonymous)

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- newUserObj: RunUserCreateInfo
  
  New user data
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<RunUserCreate>

Static login

login(tagoIORunURL: string, credentialsObj: RunUserLogin, region?: Regions): Promise<RunUserLoginResponse>

- Defined in src/modules/RunUser/RunUser.ts:90
Login at TagoIO Run as user (Anonymous)

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- credentialsObj: RunUserLogin
  
  Run user credentials
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<RunUserLoginResponse>

Static passwordRecover

passwordRecover(tagoIORunURL: string, email: string, region?: Regions): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:131
Sends a password recover e-mail

Parameters
- tagoIORunURL: string
  
  TagoIO Run url without http
- email: string
  
  Run user email to recover the password
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>

Static requestLoginPINCode

requestLoginPINCode(tagoIORunURL: string, credentials: RunUserCredentials, typeOTP: OTPType): Promise<string>

- Defined in src/modules/RunUser/RunUser.ts:264
Request the PIN Code for a given OTP Type.

Parameters
- tagoIORunURL: string
- credentials: RunUserCredentials
  
  Credentials
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>