IndexParams

New in 1.34.0 (BETA)

IndexParams

An object representing the parameters for the external data index callback. When the index callback is called to fetch a set of data, Scrivito executes the passed-in function, providing it with IndexParams. The application integrating the Scrivito SDK with an external data provider can use these parameters for filtering, searching, sorting, counting, and continuation.

Instance method summary

  • New in 1.34.0 (BETA)
    Returns the specified continuation index param.
  • New in 1.34.0 (BETA)
    Returns the filters resulting from the DataScope.
  • New in 1.40.0 (BETA)
    Returns whether the Scrivito SDK requests the total number of items in the current DataScope.
  • New in 1.39.0 (BETA)
    Returns the the number of items requested by the Scrivito SDK.
  • New in 1.34.0 (BETA)
    Returns the order specification resulting from the DataScope.
  • New in 1.34.0 (BETA)
    Returns the search string resulting from the DataScope.