NsgDataProvider class - nsg_data_provider library

Constructors

NsgDataProvider.new({String? name, required String applicationName, String serverUri = '', String authorizationApi = 'Api/Auth', bool useNsgAuthorization = true, bool allowConnect = true, required String firebaseToken, required String applicationVersion, Future eventOpenLoginPage()?, required NsgServerParams availableServers, String languageCode = 'ru', bool newTableLogic = false})

Properties

allowConnect ↔ bool: Если true, то будет выполнен метод connect для соединения с сервером. Может использоваться для отложенной связи с сервером
getter/setter pair
applicationName ↔ String: application name Для проверки на сервере для избежания ошибок подключения к другому серверу
getter/setter pair
applicationVersion ↔ String: Версия приложения. Проверяется на сервере для требования или рекомендации обновления
getter/setter pair
authorizationApi ↔ String: authorization path without serverUri (i.e. 'Api/Auth/Login')
getter/setter pair
availableServers ↔ NsgServerParams: Доступные сперверы
getter/setter pair
connectDuration ↔ int: getter/setter pair
eventOpenLoginPage → Future Function()?: Функция, вызываемая при необходимости отображения окна входа
final
firebaseToken ↔ String: Firebase token for this device
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
isAnonymous ↔ bool: Используется анонимный токен. Пользователь не авторизован на сервере
getter/setter pair
isDebug ↔ bool: Программа работает в режиме отладки
getter/setter pair
languageCode ↔ String: getter/setter pair
loginRequired ↔ bool: Авторизация обязательна. Если нет, работа может вестись в анонимном режиме
getter/setter pair
name ↔ String?: provider name
getter/setter pair
newTableLogic ↔ bool: getter/setter pair
paramName → String: no setter
phoneNumber ↔ String?: Номер телефона под которым авторизовался пользователь
getter/setter pair
requestDuration ↔ int: milliseconds
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
saveToken ↔ bool: Сохранять ли токен локально на устройстве
getter/setter pair
saveTokenWebDefaultTrue ↔ bool: Сохранять ли токен локально на в браузере по умолчанию. Фактически определяется параметром saveToken
getter/setter pair
serverUri ↔ String: server uri (i.e. https://your_server.com:port)
getter/setter pair
smsRequestedTime ↔ DateTime?: Время запроса sms для ограничения времени переодичности запросов
getter/setter pair
token ↔ String?: Token saved after authorization
getter/setter pair
useNsgAuthorization ↔ bool: Используется ли стандартная система авторизации NSG для получения и хранения токена пользователя
getter/setter pair

Methods

baseRequest({String? function, Map<String, dynamic>? params, Map<String, String?>? headers, String? url, String method = 'GET', bool autoRepeate = false, int autoRepeateCount = 1000, int maxRepeateDelay = 5, FutureOr<bool> retryIf(Exception)?, FutureOr<void> onRetry(Exception)?}) → Future<Map<String, dynamic>?>
baseRequestList({String? function, Map<String, dynamic>? params, dynamic postData, Map<String, String?>? headers, String? url, String method = 'GET', NsgCancelToken? cancelToken, FutureOr<void> onRetry(Exception)?}) → Future
connect(NsgBaseController controller) → Future: Connect to server If error will be occured, NsgApiException will be generated
getAuthorizationHeader() → Map<String, String>
getCaptcha() → Future<Image>
getCurrentServerToken() → Future: Прочитать сохраненный токен для текущего сервера
imageRequest({String? function, Map<String, dynamic>? params, Map<String, String?>? headers, String? url, bool debug = false, String method = 'GET'}) → Future<Image>
initialize() → Future: Initialization. Load saved token if useNsgAuthorization == true
internetConnected() → Future<bool>
loadServerAddress() → Future: Загрузить созраненный адрес сервера на устройстве Проверяет, если на устройстве есть сохраненный адрес и он находится в списке доступных серверов, устанавливает его текущим Иначе, не меняет текущий сервер и записывает его в качестве сохраненного
logout(NsgBaseController controller) → Future<bool>
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
openLoginPage() → Future: Вызывается при необходимости открыть окно логина
phoneLogin({required String phoneNumber, required String securityCode, bool? register, String? newPassword}) → Future<NsgLoginResponse>: Вход по телефону или e-mail с проверкой по полученному ранее securityCode phoneNumber - телефон или e-mail пользователя, на который был оправлен проверочный код (запрошенному ранее, например, функцией phoneLoginPassword) Параметр register опредлеляет просто вход по телефону/почте (false) или установку нового пароля пользователя (true)
phoneLoginPassword({required String phoneNumber, required String securityCode, NsgLoginType? loginType}) → Future<NsgLoginResponse>: Регистрация нового пользователя/восстановление пароля по e-mail или вход по паролю Опраделяется наличием или отсутствием securityCode В последнем случае, пользователю будет отправлен код верификации для дальнейшего использования в phoneLogin
phoneLoginRequestSMS({required String phoneNumber, required String securityCode, NsgLoginType? loginType, required String firebaseToken}) → Future<NsgLoginResponse>
resetCurrentServerToken() → Future: Удалить токен для текущего сервера (например, при logout)
resetUserToken() → Future
saveCurrentServerToken() → Future: Сохранить токен для текущего сервера
saveServerAddress(String serverAddress) → Future: Установитт новый адрес сервера и сохранить его в начтройках устройства
selectApplicationServer() → Future: Запросить список актуальных серверов приложения с управляющего сервера Если список удалось получить - он со=храняется в availableServers, а рекомендованный проставится текущим Если управляющих серверов указано несколько, запрашиваем сразу по всем для ускорения получения ответа и решения проблемы с неработающими серверами
setLocale({required String languageCode, FutureOr<void> onRetry(Exception)?}) → Future<int>: Передает локаль на сервер для получения всех строковых значений в локали пользователя
setServerByName(String name) → Future: Установить адрес сервера по имени (admin/test)
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

defaultSecurityCode ↔ String: getter/setter pair