User

Access: startiapp.User

Properties

userId

get userId(): string | null

Returns the currently registered user ID, or null if no user is registered. The value is read from memory first, falling back to localStorage under the key startiapp-clientUserId.

Example:

const id = startiapp.User.userId;
if (id) {
  console.log("Logged in as", id);
} else {
  console.log("No user registered");
}

Methods

registerId(userId): Promise<void>

Registers a user ID for the current device. This associates the device (identified by its installation ID and FCM push token) with your application's user identifier. Call this after the user logs in.

Internally, the method also triggers an External Purchase Custom Link token fetch if the integration is available.

Parameters:

Returns: Promise<void> —Resolves when the registration has been confirmed by the server.

Throws:

• Error if no FCM token is available (push notifications must be initialized first).
• Error if the server returns a non-OK HTTP status.

Example:

try {
  await startiapp.User.registerId("user-12345");
  console.log("User registered successfully");
} catch (error) {
  console.error("Registration failed:", error.message);
}

unregisterId(): Promise<void>

Unregisters the current user from the device. Call this when the user logs out. The stored user ID is cleared and the server is notified so the device is no longer associated with any user.

Returns: Promise<void> —Resolves when the server confirms the unregistration.

Throws:

• Error if the server returns a non-OK HTTP status.

Example:

await startiapp.User.unregisterId();
console.log("User logged out");

deleteUser(options?): Promise<void>

Requests deletion of the current user's account. A browser confirmation dialog is shown before the request is sent. On success, an alert informs the user that the request has been received.

Parameters:

Returns: Promise<void> —Resolves when the deletion request has been submitted to the server.

Throws:

• Error if no user ID is currently registered.
• Error if the server returns a non-OK HTTP status.

Example:

// With default messages
await startiapp.User.deleteUser();

// With custom messages
await startiapp.User.deleteUser({
  prompt: "Are you sure you want to delete your account?",
  confirmation: "Your deletion request has been received. We will follow up shortly.",
});

Types

RequestUserDeletionOptions

Options for customizing the deleteUser confirmation dialogs.

interface RequestUserDeletionOptions {
  /** Text shown in the confirmation dialog before sending the request. */
  prompt?: string;
  /** Text shown in the alert after the request succeeds. */
  confirmation?: string;
}