NsgDataRequest<T extends NsgDataItem> class
Properties
-
cancelToken
↔ NsgCancelToken?
-
Токен текущего запроса. При повторном вызове запроса, предыдущий запрос будет отменен автоматически
В будущем, планируется добавить механизм, уведомляющий сервер об отмене запроса с целью прекращения подготовки ненужных данных
getter/setter pair
-
dataItemType
↔ Type
-
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
items
↔ List<T>
-
getter/setter pair
-
retryIf
↔ FutureOr<bool> Function(Exception)?
-
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageType
↔ NsgDataStorageType
-
getter/setter pair
-
totalCount
↔ int?
-
Сколько всего элементов, удовлетворяющих условиям поиска, есть на сервере
getter/setter pair
Methods
-
loadAllReferents(List<NsgDataItem> items, List<String>? loadReference, {String tag = '', bool readTableParts = true})
→ Future
-
-
loadDataAndReferences(Map response, List<String> loadReference, String tag, {NsgDataRequestParams? filter})
→ Future<List>
-
Загружает данные из response, представляющего из себя Map.
основные объекты лежат в results, кэшируемые по названию полей основного объекта
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
requestItem({NsgDataRequestParams? filter, bool autoAuthorize = true, String tag = '', List<String>? loadReference, String function = '', String method = 'GET', bool addCount = true, dynamic postData, bool autoRepeate = false, int autoRepeateCount = 1000, FutureOr<bool> retryIf(Exception)?, FutureOr<void> onRetry(Exception)?, NsgCancelToken? cancelToken})
→ Future<T>
-
Оснорвной метод запроса данных
Выполняет запрос по стандартному методу, заданному в объекте
Можно перекрыть для изменения логики запроса
filter = доп. фильтр, особенное внимание следует обратить на его сво-во compare
autoAuthorize - переход на авторизацию, если будет получен отказ в доступе
tag - доп признак для кэширования
loadReference - список полей для дочитывания, можно передавать через точку, null - будут дочитаны все поля
ссылочного типа первого уровн, пустой массив - не будет дочитано ничего
Обратите внимание, по умолчанию дочитываются все поля, что может негативно сказаться на производительности
function - url вызываемого метода, если не задан, будет взят url данного объекта по умолчанию
method - метод запроса. Рекомендуем всегда использовать POST из-за отсутствия ограничений на передаваемые параметры
addCount - в фильтр будет добавлено ограничение считываемых объектов до одного
postData - передаваемые данные. Не рекомендуется использовать напрямую
autoRepeate - повторять ли запрос в случае ошибки связи
autoRepeateCount - максимальное количество повторов
retryIf - функция, вызываемая перед каждым повторным вызовом. Если вернет false, повторы будут остановлены
onRetry - функция, вызываемая при каждом повторе запроса
requestRegime - режим запроса. Позволяет определить для чего загружаются данные при перекрытии логики данного метода
-
requestItems({NsgDataRequestParams? filter, bool autoAuthorize = true, String tag = '', List<String>? loadReference, String function = '', String method = 'GET', dynamic postData, bool autoRepeate = true, int autoRepeateCount = 10, FutureOr<bool> userRetryIf(Exception)?, FutureOr<void> userOnRetry(Exception)?, NsgCancelToken? cancelToken})
→ Future<List<T>>
-
Запрос одного объекта. Для запроса списка объектов используйте requestItems
Выполняет запрос по стандартному методу, заданному в бъекте
Можно перекрыть для изменения логики запроса
filter = доп. фильтр, особенное внимание следует обратить на его сво-во compare
autoAuthorize - переход на авторизацию, если будет получен отказ в доступе
tag - доп признак для кэширования
loadReference - список полей для дочитывания, можно передавать через точку, null - будут дочитаны все поля
ссылочного типа первого уровн, пустой массив - не будет дочитано ничего
Обратите внимание, по умолчанию дочитываются все поля, что может негативно сказаться на производительности
function - url вызываемого метода, если не задан, будет взят url данного объекта по умолчанию
method - метод запроса. Рекомендуем всегда использовать POST из-за отсутствия ограничений на передаваемые параметры
postData - передаваемые данные. Не рекомендуется использовать напрямую
autoRepeate - повторять ли запрос в случае ошибки связи
autoRepeateCount - максимальное количество повторов
retryIf - функция, вызываемая перед каждым повторным вызовом. Если вернет false, повторы будут остановлены
onRetry - функция, вызываемая при каждом повторе запроса
-
toString()
→ String
-
A string representation of this object.
inherited
Static Methods
-
addAllReferences(Type type, {List<String> exceptFields = const []})
→ List<String>
-
Добавить в вписок все ссылочные типа объекта типа type
Если среди полей будет табличная часть, ее ссылочные поля также будут
добавлены в список через имяТаблицы.имяПоля