Class UserInventoryItemFactory

Factory for creating UserInventoryItem instances. Use this factory to work with user-owned inventory items.

Remarks

This factory should be instantiated once per application and reused across your codebase.

Example

// In your initialization file (e.g., utils/topiaInit.ts)
import { Topia, UserInventoryItemFactory } from "@rtsdk/topia";
const topia = new Topia({ config });
export const UserInventoryItem = new UserInventoryItemFactory(topia);

Index

Constructors

constructor

new UserInventoryItemFactory(topia: Topia): UserInventoryItemFactory
Parameters
- topia: Topia
Returns UserInventoryItemFactory
- Defined in factories/UserInventoryItemFactory.ts:22

Properties

topia

topia: Topia

Methods

create

create(
    inventoryItemId: string,
    userId: number,
    quantity: number,
    options?: UserInventoryItemOptionalInterface,
): UserInventoryItem
Instantiate a new instance of UserInventoryItem class for a user's owned item.
Parameters
- inventoryItemId: string
- userId: number
- quantity: number
- Optionaloptions: UserInventoryItemOptionalInterface
Returns UserInventoryItem
Returns a new UserInventoryItem object for interacting with the specified item.
Example
```
const userItem = UserInventoryItem.create("item-id-123", 42, 5, { credentials });
```
- Defined in factories/UserInventoryItemFactory.ts:36

get

get(
inventoryItemId: string,
options?: UserInventoryItemOptionalInterface,
): Promise<UserInventoryItem>
Retrieve a user inventory item and all its properties.
Parameters
- inventoryItemId: string
- Optionaloptions: UserInventoryItemOptionalInterface
Returns Promise<UserInventoryItem>
Returns a new UserInventoryItem object with all properties.
Example
```
const userItem = await UserInventoryItem.get("item-id-123", 42, { credentials });
```
- Defined in factories/UserInventoryItemFactory.ts:55

Class UserInventoryItemFactory

Remarks

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserInventoryItemFactory

Properties

topia

Methods

create

Parameters

Returns UserInventoryItem

Example

get

Parameters

Returns Promise<UserInventoryItem>

Example

Settings

On This Page