Type alias RunViewResult<T>

RunViewResult<T>: {
    ErrorMessage: string;
    ExecutionTime: number;
    Results: T[];
    RowCount: number;
    Success: boolean;
    TotalRowCount: number;
    UserViewRunID?: string;
}

Result of a RunView() execution. Contains the query results along with execution metadata like timing, row counts, and error information.

Type Parameters

  • T = any

Type declaration

  • ErrorMessage: string

    If Success is false, this will contain a message describing the error condition.

  • ExecutionTime: number

    Time elapsed in executing the view (in milliseconds)

  • Results: T[]

    The array of records returned by the view, only valid if Success is true

  • RowCount: number

    Number of rows returned in the Results[] array

  • Success: boolean

    Was the view run successful or not

  • TotalRowCount: number

    Total number of rows that match the view criteria, not just the number returned in the Results[] array This number will only be different when the view is configured to have a UserViewMaxRows value and the criteria of the view in question has more than that # of rows. Otherwise it will be the same value as RowCount.

  • Optional UserViewRunID?: string

    The newly created UserViews.ID value - only provided if RunViewParams.SaveViewResults=true

Settings

Member Visibility

Theme