daktela_connector library
Classes
- DaktelaConnector
- DaktelaConnectorConfig
- Configuration used in DaktelaConnector url - URL of Daktela instance accessToken - user's access token used for authentication timeout - request timeout longPollingTimeout - in case you implement your custom app pull data worker, you are allowed to set long polling requests timeout userAgent - your app user agent authType - authentication method (see DaktelaAuthType). If null, falls back to cookieAuth for backward compatibility. cookieAuth - @deprecated Use authType instead. Allows you to authenticate request through cookies (default value is false and in that case access token will be sent via X-AUTH-TOKEN header) acceptLanguage - Accept-Language header value clientTimeZone - client time zone (IANA TZ format, e.g. 'Europe/Prague'). NOTE: time zone is client's time zone so it's applied for authorized requests only. logger - instance of DaktelaLogger errors - instance of DaktelaErrorMessages refreshToken - new logic from v32 - tokens are updated through refresh token
- DaktelaErrorMessages
- Customization of errors produced by DaktelaConnector general - general error message timeout - timeout error message unauthorized - unauthorized error message notFound - not found error message (when you are trying to reach not existing model)
- DaktelaFilter
- Allows to filter records by lists of type DaktelaFilterField and DaktelaFilter logic - logic operator of filter fields - list of atomic fields contained in filter filters - list of sub-filters
- DaktelaFilterField
- Atomic part of Daktela's filter. field - name of field operator - filter operator value - expected value ignoreCase - optional flag for case sensitive filtering
- DaktelaLogger
-
Configuration of DaktelaLogger used in DaktelaConnector
callback is a method that is called during processing HTTP requests. In all the cases it provides
messageand in more specific cases (such as errors) areerrorandstackTracealso provided. In this method you are allowed to set up custom logging strategy. level defines logger verbosity. - DaktelaPagination
- Pagination of records take defines size of one page
- DaktelaResponse
- Standard response from server statusCode of response, result contains returned data, total is total number of records (in case this number is contained in response), time is DateTime returned in response. timeZone is time zone of time. headers of response
- DaktelaSort
- Allows to sort records by list of fields (DaktelaSortField) fields - list of atomic sorts contained in filter
- DaktelaSortField
- Atomic part of Daktela's sort. field - name of field direction - sort direction
Enums
- DaktelaAuthType
- Authentication type for Daktela V6 API requests.
- DaktelaLogLevel
- Enumerator defining logger verbosity
Extensions
-
DaktelaQueryMap
on Map<
String, dynamic> - Extension of Map<String, dynamic> that allows to create Daktela API query map
Exceptions / Errors
- DaktelaException
- Error response from server statusCode of response, error message.
- DaktelaNotFoundException
- Thrown in case of invalid credentials
- Thrown in case of invalid credentials