thingsboard_client library
Dart implementation of ThingsBoard API client.
Classes
-
AbstractDataQuery<
T extends EntityDataPageLink> - AccountTwoFaSettings
-
AdditionalInfoBased<
T extends HasUuid> - AdminService
- AdminSettings
- AdminSettingsId
- AggHistoryCmd
- AggKey
- AggTimeSeriesCmd
- Alarm
- AlarmAssignee
- AlarmCommentId
- AlarmData
- AlarmDataCmd
- AlarmDataPageLink
- AlarmDataQuery
- AlarmDataUnsubscribeCmd
- AlarmDataUpdate
- AlarmId
- AlarmInfo
- AlarmQuery
- AlarmQueryV2
- AlarmService
- ApiUsageStateFilter
- ApiUsageStateId
- Asset
- AssetId
- AssetInfo
- AssetProfile
- AssetProfileId
- AssetProfileInfo
- AssetProfileService
- AssetSearchQuery
- AssetSearchQueryFilter
- AssetService
- AssetTypeFilter
- AttributeData
- AttributeExportData
- AttributeKvEntry
- AttributesEntityView
- AttributeService
- AttributesSubscriptionCmd
- AuditLog
- AuditLogId
- AuditLogService
- AuthCmd
- AuthUser
- AutoCommitSettings
- AutoVersionCreateConfig
- AwsSnsSmsProviderConfiguration
- BackupCodeTwoFaAccountConfig
- BackupCodeTwoFaProviderConfig
- BaseAttributeKvEntry
-
BaseData<
T extends HasUuid> - BaseEventBody
- BaseWidgetType
- BasicKvEntry
- BasicTsKvEntry
- BooleanDataEntry
- BooleanFilterPredicate
- BranchInfo
- ClaimRequest
- ClaimResult
- CmdUpdate
- CoapDeviceProfileTransportConfiguration
- CoapDeviceTransportConfiguration
- ComparisonTsValue
- ComplexFilterPredicate
- ComplexVersionCreateRequest
- ComponentDescriptor
- ComponentDescriptorId
- ComponentDescriptorService
- Constants
-
ContactBased<
T extends HasUuid> - Customer
- CustomerId
- CustomerService
- Dashboard
- DashboardId
- DashboardInfo
- DashboardService
-
DataUpdate<
T> - DebugRuleChainEventBody
- DebugRuleNodeEventBody
- DefaultDeviceConfiguration
- DefaultDeviceProfileConfiguration
- DefaultDeviceProfileTransportConfiguration
- DefaultDeviceTransportConfiguration
- DefaultTenantProfileConfiguration
- Device
- DeviceConfiguration
- DeviceCredentials
- DeviceCredentialsId
- DeviceData
- DeviceExportData
- DeviceId
- DeviceInfo
- DeviceProfile
- DeviceProfileAlarm
- DeviceProfileConfiguration
- DeviceProfileData
- DeviceProfileId
- DeviceProfileInfo
- DeviceProfileService
- DeviceProfileTransportConfiguration
- DeviceProvisionConfiguration
- DeviceSearchQuery
- DeviceSearchQueryFilter
- DeviceService
- DeviceTransportConfiguration
- DeviceTypeFilter
- DoubleDataEntry
-
DynamicValue<
T> - Edge
- EdgeEvent
- EdgeEventId
- EdgeId
- EdgeInfo
- EdgeSearchQuery
- EdgeSearchQueryFilter
- EdgeService
- EdgeTypeFilter
- EmailTwoFaAccountConfig
- EmailTwoFaProviderConfig
- EntitiesVersionControlService
- EntityCountCmd
- EntityCountQuery
- EntityCountUnsubscribeCmd
- EntityCountUpdate
- EntityData
- EntityDataCmd
- EntityDataDiff
- EntityDataInfo
- EntityDataPageLink
- EntityDataQuery
- EntityDataSortOrder
- EntityDataUnsubscribeCmd
- EntityDataUpdate
-
EntityExportData<
E extends ExportableEntity< EntityId> > - EntityFilter
- EntityHistoryCmd
- EntityId
- EntityInfo
- EntityKey
- EntityListFilter
- EntityLoadError
- EntityNameFilter
- EntityQueryService
- EntityRelation
- EntityRelationInfo
- EntityRelationService
- EntityRelationsQuery
- EntitySearchQuery
- EntitySearchQueryFilter
- EntitySubtype
- EntityTypeFilter
- EntityTypeLoadResult
- EntityTypeVersionCreateConfig
- EntityTypeVersionLoadConfig
- EntityTypeVersionLoadRequest
- EntityVersion
- EntityView
- EntityViewId
- EntityViewInfo
- EntityViewSearchQuery
- EntityViewSearchQueryFilter
- EntityViewService
- EntityViewTypeFilter
- ErrorEventBody
- Event
- EventBody
- EventId
-
ExportableEntity<
I extends EntityId> -
FilterPredicateValue<
T> - GeneralSettings
- GetHistoryCmd
- HasAdditionalInfo
- HasCustomerId
- HasName
- HasOtaPackage
- HasRuleEngineProfile
- HasTenantId
- HasUuid
- HomeDashboard
- HomeDashboardInfo
- InMemoryStorage
- JsonDataEntry
- KeyFilter
- KeyFilterPredicate
- KvEntry
- LatestValueCmd
- LcEventEventBody
- LoginRequest
- LoginResponse
- LongDataEntry
- Lwm2mDeviceProfileTransportConfiguration
- Lwm2mDeviceTransportConfiguration
- MailServerSettings
- MarkAllAsReadCmd
- MarkAsReadCmd
- MobileSessionInfo
- MqttDeviceProfileTransportConfiguration
- MqttDeviceTransportConfiguration
- NodeConnectionInfo
- NotificationCountUpdate
- NotificationId
- NotificationRequestId
- NotificationRuleId
- NotificationsService
- NotificationsUpdate
- NotificationTargetId
- NotificationTemplateId
- NumericFilterPredicate
- OAuth2BasicMapperConfig
- OAuth2ClientInfo
- OAuth2ClientRegistrationTemplate
- OAuth2ClientRegistrationTemplateId
- OAuth2CustomMapperConfig
- OAuth2DomainInfo
- OAuth2Info
- OAuth2MapperConfig
- OAuth2MobileInfo
- OAuth2ParamsInfo
- OAuth2RegistrationInfo
- OAuth2Service
- OtaPackage
- OtaPackageId
- OtaPackageInfo
- OtaPackageService
- OtpBasedTwoFaProviderConfig
-
PageData<
T> - PageLink
- PlatformTwoFaSettings
- PlatformVersion
- PlatformVersionMatcher
- ProcessingStrategy
- PushNotification
- PushNotificationInfo
- PushNotificationQuery
- Queue
- QueueId
- QueueService
- RawEventBody
- RefreshTokenRequest
- RelationEntityTypeFilter
- RelationsQueryFilter
- RelationsSearchParameters
- RepositorySettings
- RequestConfig
- ResourceService
- RestJsonConverter
- Rpc
- RpcId
- RuleChain
- RuleChainConnectionInfo
- RuleChainData
- RuleChainExportData
- RuleChainId
- RuleChainMetaData
- RuleChainService
- RuleNode
- RuleNodeId
- SecuritySettings
- ShortCustomerInfo
-
SimpleKeyFilterPredicate<
T> - SingleEntityFilter
- SingleEntityVersionCreateRequest
- SingleEntityVersionLoadRequest
- SmsProviderConfiguration
- SmsTwoFaAccountConfig
- SmsTwoFaProviderConfig
- SnmpDeviceProfileTransportConfiguration
- SnmpDeviceTransportConfiguration
- SortOrder
- StatsEventBody
- StringDataEntry
- StringFilterPredicate
- SubmitStrategy
- SubscriptionCmd
- SubscriptionDataHolder
- SubscriptionUpdate
- TbResource
- TbResourceId
- TbResourceInfo
- TbStorage
- TelemetryEntityView
- TelemetryPluginCmd
- TelemetryPluginCmdsWrapper
- TelemetryService
- TelemetrySubscriber
- TelemetryWebsocketService
- Tenant
- TenantId
- TenantInfo
- TenantProfile
- TenantProfileConfiguration
- TenantProfileData
- TenantProfileId
- TenantProfileService
- TenantService
- TestSmsRequest
- ThingsboardClient
- ThingsBoardErrorCode
- TimePageLink
- TimeSeriesCmd
- TimeseriesSubscriptionCmd
- TotpTwoFaAccountConfig
- TotpTwoFaProviderConfig
- TsKvEntry
- TsValue
- TwilioSmsProviderConfiguration
- TwoFaAccountConfig
- TwoFactorAuthService
- TwoFaProviderConfig
- TwoFaProviderInfo
- UnreadCountSubCmd
- UnreadSubCmd
- UnsubscribeCmd
- UpdateMessage
- User
- UserId
- UserPasswordPolicy
- UserService
- VersionCreateConfig
- VersionCreateRequest
- VersionCreationResult
- VersionLoadConfig
- VersionLoadRequest
- VersionLoadResult
- WebsocketCmd
- WebsocketDataMsg
- WidgetsBundle
- WidgetsBundleId
- WidgetService
- WidgetType
- WidgetTypeDetails
- WidgetTypeId
- WidgetTypeInfo
Enums
- ActionStatus
- ActionType
- Aggregation
- AlarmSearchStatus
- AlarmSeverity
- AlarmStatus
- AttributeScope
- Authority
- BooleanOperation
- ChecksumAlgorithm
- ClaimResponse
- CmdUpdateType
- CoapTransportDeviceType
- ComplexOperation
- ComponentClusteringMode
- ComponentScope
- ComponentType
- ContentType
- DataType
- DeviceCredentialsType
- DeviceProfileProvisionType
- DeviceProfileType
- DeviceTransportType
- Direction
- DynamicValueSourceType
- EdgeEventActionType
- EdgeEventType
- EntityDataSortOrderDirection
- EntityFilterType
- EntityKeyType
- EntityKeyValueType
- EntityLoadErrorType
- EntitySearchDirection
- EntityType
- EventType
- FilterPredicateType
- LatestTelemetry
- MapperType
- NumericOperation
- OtaPackageType
- PlatformType
- ProcessingStrategyType
- PushNotificationStatus
- PushNotificationType
- RelationTypeGroup
- RepositoryAuthMethod
- ResourceType
- RpcStatus
- RuleChainType
- SchemeType
- ServiceType
- SmsProviderType
- SmtpProtocol
- StringOperation
- SubmitStrategyType
- SyncStrategy
- TenantNameStrategyType
- TenantProfileType
- TransportPayloadType
- TwoFaProviderType
- VersionCreateRequestType
- VersionLoadRequestType
- WsCmdType
Extensions
- ActionStatusToString on ActionStatus
- ActionTypeToString on ActionType
- AggregationToString on Aggregation
- AlarmSearchStatusToString on AlarmSearchStatus
- AlarmSeverityToString on AlarmSeverity
- AlarmStatusToString on AlarmStatus
- AttributeScopeToString on AttributeScope
- AuthorityToString on Authority
- BooleanOperationToString on BooleanOperation
- ChecksumAlgorithmToString on ChecksumAlgorithm
- ClaimResponseToString on ClaimResponse
- CoapTransportDeviceTypeToString on CoapTransportDeviceType
- ComplexOperationToString on ComplexOperation
- ComponentClusteringModeToString on ComponentClusteringMode
- ComponentScopeToString on ComponentScope
- ComponentTypeToString on ComponentType
- ContentTypeToString on ContentType
- DataTypeToString on DataType
- DeviceCredentialsTypeToString on DeviceCredentialsType
- DeviceProfileProvisionTypeToString on DeviceProfileProvisionType
- DeviceProfileTypeToString on DeviceProfileType
- DeviceTransportTypeToString on DeviceTransportType
- DirectionToString on Direction
- DynamicValueSourceTypeToString on DynamicValueSourceType
- EdgeEventActionTypeToString on EdgeEventActionType
- EdgeEventTypeToString on EdgeEventType
- EntityDataSortOrderDirectionToString on EntityDataSortOrderDirection
- EntityFilterTypeToString on EntityFilterType
- EntityKeyTypeToString on EntityKeyType
- EntityKeyValueTypeToString on EntityKeyValueType
- EntityLoadErrorTypeToString on EntityLoadErrorType
- EntitySearchDirectionToString on EntitySearchDirection
- EntityTypeToString on EntityType
- FilterPredicateTypeToString on FilterPredicateType
- LatestTelemetryToString on LatestTelemetry
- MapperTypeToString on MapperType
- NotificationStatusToString on PushNotificationStatus
- NotificationTypeToString on PushNotificationType
- NumericOperationToString on NumericOperation
- OtaPackageTypeToString on OtaPackageType
- PlatformTypeToString on PlatformType
- ProcessingStrategyTypeToString on ProcessingStrategyType
- RelationTypeGroupToString on RelationTypeGroup
- RepositoryAuthMethodToString on RepositoryAuthMethod
- ResourceTypeToString on ResourceType
- RpcStatusToString on RpcStatus
- RuleChainTypeToString on RuleChainType
- SchemeTypeToString on SchemeType
- ServiceTypeToString on ServiceType
- SmtpProtocolToString on SmtpProtocol
- SSmsProviderTypeToString on SmsProviderType
- StringOperationToString on StringOperation
- SubmitStrategyTypeToString on SubmitStrategyType
- SyncStrategyToString on SyncStrategy
- TenantNameStrategyTypeToString on TenantNameStrategyType
- TenantProfileTypeToString on TenantProfileType
- TransportPayloadTypeToString on TransportPayloadType
- TwoFaProviderTypeToString on TwoFaProviderType
- VersionCreateRequestTypeToString on VersionCreateRequestType
- VersionLoadRequestTypeToString on VersionLoadRequestType
- WsCmdTypeTypeToString on WsCmdType
Constants
- ACTIVATE_TOKEN_REGEX → const String
- CONTAINS_TYPE → const String
-
entityFilterTypeToStringMap
→ const Map<
EntityFilterType, String> -
exportableEntityTypes
→ const List<
EntityType> - MANAGES_TYPE → const String
- MAX_PUBLISH_COMMANDS → const int
- nullUuid → const String
- RECONNECT_INTERVAL → const int
- WS_IDLE_TIMEOUT → const int
Properties
-
stringToEntityFilterTypeMap
↔ Map<
String, EntityFilterType> -
getter/setter pair
- syncCompute ↔ TbCompute
-
getter/setter pair
Functions
-
actionStatusFromString(
String value) → ActionStatus -
actionTypeFromString(
String value) → ActionType -
aggregationFromString(
String value) → Aggregation -
alarmSearchStatusFromString(
String value) → AlarmSearchStatus -
alarmSeverityFromString(
String value) → AlarmSeverity -
alarmStatusFromString(
String value) → AlarmStatus -
attributeScopeFromString(
String value) → AttributeScope -
booleanOperationFromString(
String value) → BooleanOperation -
checksumAlgorithmFromString(
String value) → ChecksumAlgorithm -
claimResponseFromString(
String value) → ClaimResponse -
cmdUpdateTypeFromString(
String value) → CmdUpdateType -
coapTransportDeviceTypeFromString(
String value) → CoapTransportDeviceType -
complexOperationFromString(
String value) → ComplexOperation -
componentClusteringModeFromString(
String value) → ComponentClusteringMode -
componentScopeFromString(
String value) → ComponentScope -
componentTypeFromString(
String value) → ComponentType -
contentTypeFromString(
String value) → ContentType -
createDefaultEntityTypesVersionCreate(
) → Map< EntityType, EntityTypeVersionCreateConfig> -
createDefaultEntityTypesVersionLoad(
) → Map< EntityType, EntityTypeVersionLoadConfig> -
createLocalFileStorage(
String fileName, [String? path]) → TbStorage -
dataFromJson<
T> (List jsonData, FromJsonFunction< T> fromJson) → List<T> -
dataToString<
T> (List< T> data) → String -
dataTypeFromString(
String value) → DataType -
defaultHttpOptions(
{bool ignoreLoading = false, bool ignoreErrors = false, bool resendRequest = false}) → Options -
defaultHttpOptionsFromConfig(
RequestConfig? config) → Options -
deviceCredentialsTypeFromString(
String value) → DeviceCredentialsType -
deviceProfileProvisionTypeFromString(
String? value) → DeviceProfileProvisionType -
deviceProfileTypeFromString(
String value) → DeviceProfileType -
deviceTransportTypeFromString(
String value) → DeviceTransportType -
dynamicValueSourceTypeFromString(
String value) → DynamicValueSourceType -
edgeEventActionTypeFromString(
String value) → EdgeEventActionType -
edgeEventTypeFromString(
String value) → EdgeEventType -
emptyPageData<
T> () → PageData< T> -
entityDataSortOrderDirectionFromString(
String value) → EntityDataSortOrderDirection -
entityFilterTypeFromString(
String value) → EntityFilterType -
entityKeyTypeFromString(
String value) → EntityKeyType -
entityKeyValueTypeFromString(
String value) → EntityKeyValueType -
entityLoadErrorTypeFromString(
String value) → EntityLoadErrorType -
entitySearchDirectionFromString(
String value) → EntitySearchDirection -
entityTypeFromString(
String value) → EntityType -
filterPredicateTypeFromString(
String value) → FilterPredicateType -
isSuccessful(
Future< Response> requestFunction(RequestConfig requestConfig), {RequestConfig? requestConfig}) → Future<bool> -
mapperTypeFromString(
String value) → MapperType -
notificationStatusFromString(
String value) → PushNotificationStatus -
notificationTypeFromString(
String value) → PushNotificationType -
nullIfNotFound<
T> (Future< T?> fetchFunction(RequestConfig requestConfig), {RequestConfig? requestConfig}) → Future<T?> -
numericOperationFromString(
String value) → NumericOperation -
otaPackageTypeFromString(
String value) → OtaPackageType -
parseAlarmDataPageData(
Map< String, dynamic> json) → PageData<AlarmData> -
parseAlarmInfoPageData(
Map< String, dynamic> json) → PageData<AlarmInfo> -
parseAssetInfoPageData(
Map< String, dynamic> json) → PageData<AssetInfo> -
parseAssetPageData(
Map< String, dynamic> json) → PageData<Asset> -
parseAssetProfileInfoPageData(
Map< String, dynamic> json) → PageData<AssetProfileInfo> -
parseAssetProfilePageData(
Map< String, dynamic> json) → PageData<AssetProfile> -
parseAuditLogPageData(
Map< String, dynamic> json) → PageData<AuditLog> -
parseCustomerPageData(
Map< String, dynamic> json) → PageData<Customer> -
parseDashboardInfoPageData(
Map< String, dynamic> json) → PageData<DashboardInfo> -
parseDeviceInfoPageData(
Map< String, dynamic> json) → PageData<DeviceInfo> -
parseDevicePageData(
Map< String, dynamic> json) → PageData<Device> -
parseDeviceProfileInfoPageData(
Map< String, dynamic> json) → PageData<DeviceProfileInfo> -
parseDeviceProfilePageData(
Map< String, dynamic> json) → PageData<DeviceProfile> -
parseEdgeEventPageData(
Map< String, dynamic> json) → PageData<EdgeEvent> -
parseEdgeInfoPageData(
Map< String, dynamic> json) → PageData<EdgeInfo> -
parseEdgePageData(
Map< String, dynamic> json) → PageData<Edge> -
parseEntityDataPageData(
Map< String, dynamic> json) → PageData<EntityData> -
parseEntityVersionPageData(
Map< String, dynamic> json) → PageData<EntityVersion> -
parseEntityViewInfoPageData(
Map< String, dynamic> json) → PageData<EntityViewInfo> -
parseEntityViewPageData(
Map< String, dynamic> json) → PageData<EntityView> -
parseNotificationPageData(
Map< String, dynamic> json) → PageData<PushNotification> -
parseOauth2ClientRegistrationTemplates(
List json) → List< OAuth2ClientRegistrationTemplate> -
parseOtaPackageInfoPageData(
Map< String, dynamic> json) → PageData<OtaPackageInfo> -
parseQueuePageData(
Map< String, dynamic> json) → PageData<Queue> -
parseResourceInfoPageData(
Map< String, dynamic> json) → PageData<TbResourceInfo> -
parseRpcPageData(
Map< String, dynamic> json) → PageData<Rpc> -
parseRuleChainPageData(
Map< String, dynamic> json) → PageData<RuleChain> -
parseRuleChainsList(
List json) → List< RuleChain> -
parseTenantInfoPageData(
Map< String, dynamic> json) → PageData<TenantInfo> -
parseTenantPageData(
Map< String, dynamic> json) → PageData<Tenant> -
parseTenantProfileInfoPageData(
Map< String, dynamic> json) → PageData<EntityInfo> -
parseTenantProfilePageData(
Map< String, dynamic> json) → PageData<TenantProfile> -
parseUserPageData(
Map< String, dynamic> json) → PageData<User> -
parseWebsocketDataMessage(
dynamic raw) → WebsocketDataMsg -
parseWidgetsBundleList(
List json) → List< WidgetsBundle> -
parseWidgetsBundlePageData(
Map< String, dynamic> json) → PageData<WidgetsBundle> -
parseWidgetTypeDetailsList(
List json) → List< WidgetTypeDetails> -
parseWidgetTypeInfoPageData(
Map< String, dynamic> json) → PageData<WidgetTypeInfo> -
parseWidgetTypeInfosList(
List json) → List< WidgetTypeInfo> -
parseWidgetTypeList(
List json) → List< WidgetType> -
platformTypeFromString(
String value) → PlatformType -
processingStrategyTypeFromString(
String value) → ProcessingStrategyType -
relationTypeGroupFromString(
String value) → RelationTypeGroup -
repositoryAuthMethodFromString(
String value) → RepositoryAuthMethod -
resourceTypeFromString(
String value) → ResourceType -
rpcStatusFromString(
String value) → RpcStatus -
ruleChainTypeFromString(
String value) → RuleChainType -
schemeTypeFromString(
String value) → SchemeType -
smsProviderTypeFromString(
String value) → SmsProviderType -
smtpProtocolFromString(
String value) → SmtpProtocol -
sortOrderFromString(
String strSortOrder) → SortOrder -
stringOperationFromString(
String value) → StringOperation -
submitStrategyTypeFromString(
String value) → SubmitStrategyType -
syncStrategyFromString(
String value) → SyncStrategy -
tenantNameStrategyTypeFromString(
String value) → TenantNameStrategyType -
tenantProfileTypeFromString(
String value) → TenantProfileType -
toThingsboardError(
dynamic error, [StackTrace? stackTrace]) → ThingsboardError -
transportPayloadTypeFromString(
String value) → TransportPayloadType -
twoFaProviderTypeFromString(
String value) → TwoFaProviderType -
versionCreateRequestTypeFromString(
String value) → VersionCreateRequestType -
versionLoadRequestTypeFromString(
String value) → VersionLoadRequestType -
wsCmdTypeTypeFromString(
String value) → WsCmdType
Typedefs
- ErrorCallback = void Function(ThingsboardError error)
-
FromIdFunction<
T> = T Function(String id) -
FromJsonFunction<
T> = T Function(dynamic json) - LoadFinishedCallback = void Function()
- LoadStartedCallback = void Function()
- MfaAuthCallback = void Function()
-
TbCompute
= Future<
R> Function<Q, R>(TbComputeCallback< Q, R> callback, Q message) -
TbComputeCallback<
Q, R> = FutureOr< R> Function(Q message) - UserLoadedCallback = void Function()