Class RunUser

Hierarchy

TagoIOModule<GenericModuleParams>
- RunUser

Constructors

constructor

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

Properties

SDB

SDB: SDB = ...

Methods

confirmOTP

confirmOTP(tagoIORunURL, pinCode, typeOTP): Promise<string>
Confirm OTP enabling process for a given OTP Type
Parameters
- tagoIORunURL: string
- pinCode: string
- typeOTP: OTPType
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:313

delete

delete(tagoIORunURL): Promise<string>
Delete Run user info
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:75

disableOTP

disableOTP(tagoIORunURL, credentials, typeOTP): Promise<string>
Enable OTP for a given OTP Type
Parameters
- tagoIORunURL: string
- credentials: RunUserCredentials
  Credentials
- typeOTP: OTPType
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:299

edit

edit(tagoIORunURL, userChangesObj): Promise<string>
Edit Run user info
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- userChangesObj: Partial<RunUserInfo>
  Data to change in user
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:61

enableOTP

enableOTP(tagoIORunURL, credentials, typeOTP): Promise<string>
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>
- Defined in modules/RunUser/RunUser.ts:284

info

info(tagoIORunURL): Promise<RunUserInfo>
Get Run user info
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
Returns Promise<RunUserInfo>
- Defined in modules/RunUser/RunUser.ts:23

notificationButton

notificationButton(tagoIORunURL, notificationID, buttonID): Promise<any>
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>
- Defined in modules/RunUser/RunUser.ts:236

notificationDelete

notificationDelete(tagoIORunURL, notificationID): Promise<string>
Delete notification
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- notificationID: string
  TagoIO Run notification id
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:250

notificationList

notificationList(tagoIORunURL, queryObj?): Promise<NotificationInfo[]>
List notifications.
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- Optional queryObj: NotificationQuery
Returns Promise<NotificationInfo[]>
- Defined in modules/RunUser/RunUser.ts:163

notificationMarkAllRead

notificationMarkAllRead(tagoIORunURL): Promise<string>
Mark all notifications as read
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:222

notificationMarkRead

notificationMarkRead(tagoIORunURL, notificationIDs): Promise<string>
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>
- Defined in modules/RunUser/RunUser.ts:179

notificationMarkUnread

notificationMarkUnread(tagoIORunURL, notificationIDs): Promise<string>
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>
- Defined in modules/RunUser/RunUser.ts:201

passwordChange

passwordChange(tagoIORunURL, password): Promise<string>
Change password using token of the password recover.
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- password: string
  New password
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:147

`Static` confirmUser

confirmUser(tagoIORunURL, token, region?): Promise<string>
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>
- Defined in modules/RunUser/RunUser.ts:114

`Static` create

create(tagoIORunURL, newUserObj, region?): Promise<RunUserCreate>
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>
- Defined in modules/RunUser/RunUser.ts:40

`Static` login

login(tagoIORunURL, credentialsObj, region?): Promise<RunUserLoginResponse>
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>
- Defined in modules/RunUser/RunUser.ts:90

`Static` passwordRecover

passwordRecover(tagoIORunURL, email, region?): Promise<string>
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>
- Defined in modules/RunUser/RunUser.ts:131

`Static` requestLoginPINCode

requestLoginPINCode(tagoIORunURL, credentials, typeOTP): Promise<string>
Request the PIN Code for a given OTP Type.
Parameters
- tagoIORunURL: string
- credentials: RunUserCredentials
  Credentials
- typeOTP: OTPType
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:264