SW Combine SDK
    Preparing search index...

    Interface ListInventoryEntitiesOptions<T>

    interface ListInventoryEntitiesOptions<
        T extends InventoryEntityType = InventoryEntityType,
    > {
        assignType: InventoryAssignType;
        entityType: T;
        filter_inclusion?: InventoryFilterInclusion[];
        filter_type?: InventoryFilterType[];
        filter_value?: string[];
        item_count?: number;
        start_index?: number;
        uid: string;
    }

    Type Parameters

    Index

    Properties

    assignType entityType filter_inclusion? filter_type? filter_value? item_count? start_index? uid

    Properties

    assignType: InventoryAssignType

    Assignment type: 'owner', 'commander', or 'pilot'

    entityType: T

    Entity type: 'ships', 'vehicles', 'stations', 'cities', 'facilities', 'planets', 'items', 'npcs', 'droids', 'creatures', or 'materials'

    filter_inclusion?: InventoryFilterInclusion[]

    Whether each filter should include or exclude matches. Default: 'includes'

    filter_type?: InventoryFilterType[]

    Filter types to apply to the query

    filter_value?: string[]

    Values corresponding to each filter type

    item_count?: number

    Number of items to retrieve. Default: 50, Max: 200

    start_index?: number

    Starting position for pagination (1-based). Default: 1

    uid: string

    Settings

    Member Visibility

    On This Page

    Properties