method

LocalAPI.ListWindow

Read one count-free bounded unique-index range for reconciliation work.

Arguments

ArgumentTypeDescription
ctxcontext.ContextRequest context.
collectionstringAuthored collection slug.
optionsListWindowOptionsUnique-index range, projection, actor, and locale controls.

Returns

At most Limit authorized documents plus an overflow indicator.

(store.Window, error)

How it works

Requires collection read access to resolve to Allow and the adapter transaction to implement store.WindowTransaction.

Full signature

func (local *LocalAPI) ListWindow( ctx context.Context, collection string, options ListWindowOptions, ) (store.Window, error)

Source core/local.go:397

Related types

  • LocalAPI

    In-process content operations that share the REST authorization and lifecycle pipeline.

  • ListWindowOptions

    A count-free bounded unique-index range for background work.

  • Window

    A count-free bounded range result.