Class RunUser

End-user runtime context for TagoIO Run applications

This class provides functionality for managing end-users in TagoIO Run applications, including user authentication, profile management, and user-specific data operations. Used primarily in customer-facing applications built with TagoIO Run.

Example: User authentication

import { RunUser } from "@tago-io/sdk";

const runUser = new RunUser({ token: "your-run-token" });

// User login
const loginResult = await runUser.login({
  email: "user@example.com",
  password: "userpassword"
});

// Get user info
const userInfo = await runUser.info();

Example: User management

// Create a new user
const newUser = await runUser.create({
  email: "newuser@example.com",
  password: "securepassword",
  name: "New User"
});

// Access user-specific database
const sdb = runUser.sdb;
await sdb.set("user_preference", "dark_mode");

Constructors

constructor

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

Properties

SDB

SDB: SDB = ...

Methods

confirmOTP

confirmOTP(
    tagoIORunURL: string,
    pinCode: string,
    typeOTP: OTPType,
): 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:357

delete

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

disableOTP

disableOTP(
    tagoIORunURL: string,
    credentials: RunUserCredentials,
    typeOTP: OTPType,
): 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:343

edit

edit(
tagoIORunURL: string,
userChangesObj: Partial<RunUserInfo>,
): 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:97

enableOTP

enableOTP(
    tagoIORunURL: string,
    credentials: RunUserCredentials,
    typeOTP: OTPType,
): 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:328

info

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

notificationButton

notificationButton(
    tagoIORunURL: string,
    notificationID: string,
    buttonID: string,
): 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:276

notificationDelete

notificationDelete(
tagoIORunURL: string,
notificationID: string,
): 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:290

notificationList

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

notificationMarkAllRead

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

notificationMarkRead

notificationMarkRead(
tagoIORunURL: string,
notificationIDs: string | string[],
): 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:223

notificationMarkUnread

notificationMarkUnread(
tagoIORunURL: string,
notificationIDs: string | string[],
): 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:243

passwordChange

passwordChange(tagoIORunURL: string, password: string): 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:191

`Static`confirmUser

confirmUser(
    tagoIORunURL: string,
    token: string,
    region?: RegionsObj | Regions,
): Promise<string>
Confirm User on TagoIO Run (Anonymous)
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- token: string
  TagoIO Run user token
- Optionalregion: RegionsObj | Regions
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:150

`Static`create

create(
    tagoIORunURL: string,
    newUserObj: RunUserCreateInfo,
    region?: RegionsObj | Regions,
): Promise<RunUserCreate>
Create new TagoIO Run User (Anonymous)
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- newUserObj: RunUserCreateInfo
  New user data
- Optionalregion: RegionsObj | Regions
  TagoIO Region Server [default usa-1]
Returns Promise<RunUserCreate>
- Defined in modules/RunUser/RunUser.ts:76

`Static`login

login(
    tagoIORunURL: string,
    credentialsObj: RunUserLogin,
    region?: RegionsObj | Regions,
): Promise<RunUserLoginResponse>
Login at TagoIO Run as user (Anonymous)
Parameters
- tagoIORunURL: string
  TagoIO Run url without http
- credentialsObj: RunUserLogin
  Run user credentials
- Optionalregion: RegionsObj | Regions
  TagoIO Region Server [default usa-1]
Returns Promise<RunUserLoginResponse>
- Defined in modules/RunUser/RunUser.ts:126

`Static`passwordRecover

passwordRecover(
    tagoIORunURL: string,
    email: string,
    region?: RegionsObj | Regions,
): 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
- Optionalregion: RegionsObj | Regions
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/RunUser/RunUser.ts:171

`Static`requestLoginPINCode

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

Class RunUser

Example: User authentication

Example: User management

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RunUser

Properties

SDB

Methods

confirmOTP

Parameters

Returns Promise<string>

delete

Parameters

Returns Promise<string>

disableOTP

Parameters

Returns Promise<string>

edit

Parameters

Returns Promise<string>

enableOTP

Parameters

Returns Promise<string>

info

Parameters

Returns Promise<RunUserInfo>

notificationButton

Parameters

Returns Promise<any>

notificationDelete

Parameters

Returns Promise<string>

notificationList

Parameters

Returns Promise<NotificationInfo[]>

notificationMarkAllRead

Parameters

Returns Promise<string>

notificationMarkRead

Parameters

Returns Promise<string>

notificationMarkUnread

Parameters

Returns Promise<string>

passwordChange

Parameters

Returns Promise<string>

StaticconfirmUser

Parameters

Returns Promise<string>

Staticcreate

Parameters

Returns Promise<RunUserCreate>

Staticlogin

Parameters

Returns Promise<RunUserLoginResponse>

StaticpasswordRecover

Parameters

Returns Promise<string>

StaticrequestLoginPINCode

Parameters

Returns Promise<string>

Settings

On This Page

`Static`confirmUser

`Static`create

`Static`login

`Static`passwordRecover

`Static`requestLoginPINCode