useRecycleBinItems

useRecycleBinItems(
    options?: RecycleBinItemsOptions,
    deps?: any[]): IRecycleBinItemObject[] | null | undefined;

Returns all recycle bin items.

Examples

Get web recycle bin items,

const items = useRecycleBinItems();

// Explicit scope
const items = useRecycleBinItems({
    scope: "web"
});

Get site recycle bin items,

const items = useRecycleBinItems({
    scope: "site"
});

Query recycle bin items,

const items = useRecycleBinItems({
    query: {
        top: 2,
        select: ["Title", "ItemState"],
    }
});

Parameters

NameTypeDescriptionTracked for changes
options?RecycleBinItemsOptionsuseRecyclebinItems hook optionsPartially
deps?DependencyListHook dependency list.Yes