RTSDK
    Preparing search index...

    Class UserInventoryItem

    Controller for a user's owned inventory item.

    This class should be instantiated via UserInventoryItemFactory only.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    created_at? credentials description? grant_source id image_path? interactive_key_id? item_id jwt? metadata? name? quantity requestOptions status? topia type updated_at? user_id userItemId

    Methods

    errorHandler fetchInventoryItemById fetchUserInventoryItemById topiaPublicApi

    Constructors

    Properties

    created_at?: Date
    credentials: undefined | InteractiveCredentials
    description?: string
    grant_source: string
    id: string
    image_path?: string
    interactive_key_id?: string
    item_id: string
    jwt?: string
    metadata?: null | object
    name?: string
    quantity: number
    requestOptions: object
    status?: string
    topia: Topia
    type: string
    updated_at?: Date
    user_id: string
    userItemId: string

    Methods

    • Parameters

      • __namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string }

      Returns {
          data: {};
          message: string;
          method: string;
          params: object;
          sdkMethod: undefined | string;
          stack: string;
          stackTrace: Error;
          status: number;
          success: boolean;
          url: string;
      }

    • Fetches the inventory item details from the platform and assigns them to this instance.

      Returns Promise<InventoryItem>

      Returns when the item has been fetched and assigned.

      await item.fetchInventoryItemById();

    • Fetches the user inventory item details from the platform and assigns them to this instance.

      Returns Promise<void>

      Returns when the item has been fetched and assigned.

      await userInventoryItem.fetchUserInventoryItemById();

    • Returns AxiosInstance

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods