interface QueryAllRequestSettings extends GetRequestSettings {
/** A callback made after each page of results is retrieved */
progress?: (ctx: QueryAllRequestProgress) => void;
}
interface QueryAllRequestProgress {
/** The number of pages retrieved so far. */
retrievedPages: number;
/** The count of records retrieved so far */
retrievedCount: number;
/** The records from the current page of results */
currentPage: WebApiRecord[];
/** The records from all pages of results retrieved so far */
records: WebApiRecord[];
/** Whether this is the progress callback for the final page of results */
isFinalPage: boolean;
}
function queryAllRequestSettingsSample() {
const busyDialog = Hsl.Dialog.openBusy({
title: 'Loading Tasks',
text: 'Loaded 0 Tasks',
});
const client = Hsl.WebApi.getClient('9.1');
return client.queryAll('task', {
filter: '_regardingobjectid_value eq 006ac1c2-b206-45f9-a306-3cbd21417db5',
select: ['subject', 'actualend', 'statecode'],
}, {
progress(progressCtx) {
busyDialog.update({
text: `Loaded ${progressCtx.retrievedCount} Tasks`,
});
},
formattedValues: true,
});
}