Interface RequestCreatePayload

Payload to send when creating an ODAG Request. selectionApp is the ID of the selection app from which the request is being made. bindSelectionState is the current selection state in the selection app at the time the request is made (this can be limited to the set of fields corresponding to the selectAppParamName properties in the link's bindings to save bandwidth on sending this request.

Hierarchy

  • RequestCreatePayload

Properties

actualRowEst bindSelectionState clientContextHandle? selectionApp selectionState? sheetName?

Properties

actualRowEst

actualRowEst: number

The current row estimate value calculated by the link's rowEstExpr property in the context of the selection app. format: int32

bindSelectionState

bindSelectionState: {}

A collection of FieldSelectionState objects.

Type declaration

    Optional clientContextHandle

    clientContextHandle?: string

    An opaque handle to a client-side object that contains the reference to the link being used.

    selectionApp

    selectionApp: string

    The system-assigned ID for an app.

    Optional selectionState

    selectionState?: {}

    A collection of FieldSelectionState objects.

    Type declaration

      Optional sheetName

      sheetName?: string

      The name of the sheet from which the request is being made.

      Settings

      Member Visibility

      Theme

      On This Page