RTSDK
    Preparing search index...

    Class UserInventoryItemFactory

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

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

    // 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

    Properties

    topia

    Methods

    create get

    Constructors

    Properties

    topia: Topia

    Methods

    • Instantiate a new instance of UserInventoryItem class for a user's owned item.

      Parameters

      • inventoryItemId: string
      • userId: number
      • quantity: number
      • Optionaloptions: object

      Returns UserInventoryItem

      Returns a new UserInventoryItem object for interacting with the specified item.

      const userItem = UserInventoryItem.create("item-id-123", 42, 5, { credentials });

    • Retrieve a user inventory item and all its properties.

      Parameters

      • inventoryItemId: string
      • Optionaloptions: object

      Returns Promise<UserInventoryItem>

      Returns a new UserInventoryItem object with all properties.

      const userItem = await UserInventoryItem.get("item-id-123", 42, { credentials });

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods