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
AlarmDataQuery
AlarmDataUnsubscribeCmd
AlarmDataUpdate
AlarmId
AlarmInfo
AlarmQuery
AlarmQueryV2
AlarmService
AllowedPermissionsInfo
ApiUsageStateFilter
ApiUsageStateId
Asset
AssetId
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
BlobEntityId
BlobEntityInfo
BlobEntityService
BlobEntityWithCustomerInfo
BooleanDataEntry
BooleanFilterPredicate
BranchInfo
ClaimRequest
ClaimResult
CmdUpdate
CoapDeviceProfileTransportConfiguration
CoapDeviceTransportConfiguration
ComparisonTsValue
ComplexFilterPredicate
ComplexVersionCreateRequest
ComponentDescriptor
ComponentDescriptorId
ComponentDescriptorService
Constants
ContactBased<T extends HasUuid>
Converter
ConverterDebugInput
ConverterId
ConverterService
Customer
CustomerId
CustomerService
CustomMenu
CustomMenuItem
CustomMenuService
CustomTranslation
CustomTranslationService
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
EdgeSearchQuery
EdgeSearchQueryFilter
EdgeService
EdgeTypeFilter
EmailTwoFaAccountConfig
EmailTwoFaProviderConfig
EntitiesByGroupNameFilter
EntitiesVersionControlService
EntityCountCmd
EntityCountQuery
EntityCountUnsubscribeCmd
EntityCountUpdate
EntityData
EntityDataCmd
EntityDataDiff
EntityDataInfo
EntityDataQuery
EntityDataSortOrder
EntityDataUnsubscribeCmd
EntityDataUpdate
EntityExportData<E extends ExportableEntity<EntityId>>
EntityFilter
EntityGroup
EntityGroupExportData
EntityGroupFilter
EntityGroupId
EntityGroupInfo
EntityGroupListFilter
EntityGroupNameFilter
EntityGroupService
EntityHistoryCmd
EntityId
EntityInfo
EntityKey
EntityListFilter
EntityLoadError
EntityNameFilter
EntityQueryService
EntityRelation
EntityRelationInfo
EntityRelationService
EntityRelationsQuery
EntitySearchQuery
EntitySearchQueryFilter
EntitySubtype
EntityTypeFilter
EntityTypeLoadResult
EntityTypeVersionCreateConfig
EntityTypeVersionLoadConfig
EntityTypeVersionLoadRequest
EntityVersion
EntityView
EntityViewId
EntityViewSearchQuery
EntityViewSearchQueryFilter
EntityViewService
EntityViewTypeFilter
ErrorEventBody
Event
EventBody
EventId
ExportableEntity<I extends EntityId>
ExportableNoTenantIdEntity<I extends EntityId>
Favicon
FilterPredicateValue<T>
GeneralSettings
GenericRolePermissions
GetHistoryCmd
GroupPermission
GroupPermissionId
GroupPermissionInfo
GroupPermissionService
HasAdditionalInfo
HasCustomerId
HasName
HasOtaPackage
HasRuleEngineProfile
HasTenantId
HasUuid
HomeDashboard
HomeDashboardInfo
InMemoryStorage
Integration
IntegrationId
IntegrationService
JsonDataEntry
KeyFilter
KeyFilterPredicate
KvEntry
LatestValueCmd
LcEventEventBody
LoginRequest
LoginResponse
LoginWhiteLabelingParams
LongDataEntry
Lwm2mDeviceProfileTransportConfiguration
Lwm2mDeviceTransportConfiguration
MailServerSettings
MarkAllAsReadCmd
MarkAsReadCmd
MergedGroupPermissionInfo
MergedGroupTypePermissionInfo
MergedUserPermissions
MobileSessionInfo
MqttDeviceProfileTransportConfiguration
MqttDeviceTransportConfiguration
NodeConnectionInfo
Notification
NotificationCountUpdate
NotificationId
NotificationInfo
NotificationRequestId
NotificationRuleId
NotificationsUpdate
NotificationTargetId
NotificationTemplateId
NumericFilterPredicate
OAuth2BasicMapperConfig
OAuth2ClientInfo
OAuth2ClientRegistrationTemplate
OAuth2ClientRegistrationTemplateId
OAuth2CustomMapperConfig
OAuth2DomainInfo
OAuth2Info
OAuth2MapperConfig
OAuth2MobileInfo
OAuth2ParamsInfo
OAuth2RegistrationInfo
OAuth2Service
OtaPackage
OtaPackageId
OtaPackageInfo
OtaPackageService
OtpBasedTwoFaProviderConfig
OwnerService
PageData<T>
Palette
PaletteSettings
PlatformTwoFaSettings
PlatformVersion
PlatformVersionMatcher
ProcessingStrategy
Queue
QueueId
QueueService
RawEventBody
RefreshTokenRequest
RelationEntityTypeFilter
RelationsQueryFilter
RelationsSearchParameters
ReportConfig
ReportParams
ReportService
RepositorySettings
RequestConfig
ResourceService
RestJsonConverter
Role
RoleId
RolePermissions
RoleService
Rpc
RpcId
RuleChain
RuleChainConnectionInfo
RuleChainData
RuleChainExportData
RuleChainId
RuleChainMetaData
RuleChainService
RuleEngineService
RuleNode
RuleNodeId
SchedulerEvent
SchedulerEventConfiguration
SchedulerEventId
SchedulerEventInfo
SchedulerEventSchedule
SchedulerEventService
SchedulerEventWithCustomerInfo
SchedulerRepeat
SecuritySettings
SelfRegistrationParams
SelfRegistrationService
ShareGroupRequest
ShortCustomerInfo
ShortEntityView
SignUpRequest
SignUpSelfRegistrationParams
SignupService
SimpleKeyFilterPredicate<T>
SingleEntityFilter
SingleEntityVersionCreateRequest
SingleEntityVersionLoadRequest
SmsProviderConfiguration
SmsTwoFaAccountConfig
SmsTwoFaProviderConfig
SnmpDeviceProfileTransportConfiguration
SnmpDeviceTransportConfiguration
SortOrder
SpecificRolePermissions
StateEntityOwnerFilter
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
TestConverterResult
TestDownLinkInputParams
TestSmsRequest
TestUpLinkInputParams
ThingsboardClient
ThingsBoardErrorCode
TimeSeriesCmd
TimeseriesSubscriptionCmd
TotpTwoFaAccountConfig
TotpTwoFaProviderConfig
TsKvEntry
TsValue
TwilioSmsProviderConfiguration
TwoFaAccountConfig
TwoFactorAuthService
TwoFaProviderConfig
TwoFaProviderInfo
UnreadCountSubCmd
UnreadSubCmd
UnsubscribeCmd
UpdateMessage
User
UserId
UserPasswordPolicy
UserPermissionsService
UserService
VersionCreateConfig
VersionCreateRequest
VersionCreationResult
VersionLoadConfig
VersionLoadRequest
VersionLoadResult
WebsocketCmd
WebsocketDataMsg
WhiteLabelingParams
WhiteLabelingService
WidgetsBundle
WidgetsBundleId
WidgetService
WidgetType
WidgetTypeDetails
WidgetTypeId
WidgetTypeInfo

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
ConverterTypeToString on ConverterType
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
IntegrationTypeToString on IntegrationType
LatestTelemetryToString on LatestTelemetry
MapperTypeToString on MapperType
NotificationStatusToString on NotificationStatus
NotificationTypeToString on NotificationType
NumericOperationToString on NumericOperation
OperationToString on Operation
OtaPackageTypeToString on OtaPackageType
PlatformTypeToString on PlatformType
ProcessingStrategyTypeToString on ProcessingStrategyType
RelationTypeGroupToString on RelationTypeGroup
RepositoryAuthMethodToString on RepositoryAuthMethod
ResourceToString on Resource
ResourceTypeToString on ResourceType
RoleTypeToString on RoleType
RpcStatusToString on RpcStatus
RuleChainTypeToString on RuleChainType
SchedulerRepeatTypeToString on SchedulerRepeatType
SchedulerTimeUnitToString on SchedulerTimeUnit
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

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
authorityFromString(String value) Authority
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
converterTypeFromString(String value) ConverterType
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
integrationTypeFromString(String value) IntegrationType
isSuccessful(Future<Response> requestFunction(RequestConfig requestConfig), {RequestConfig? requestConfig}) Future<bool>
mapperTypeFromString(String value) MapperType
notificationStatusFromString(String value) NotificationStatus
notificationTypeFromString(String value) NotificationType
nullIfNotFound<T>(Future<T?> fetchFunction(RequestConfig requestConfig), {RequestConfig? requestConfig}) Future<T?>
numericOperationFromString(String value) NumericOperation
operationFromString(String value) Operation
otaPackageTypeFromString(String value) OtaPackageType
parseAlarmDataPageData(Map<String, dynamic> json) PageData<AlarmData>
parseAlarmInfoPageData(Map<String, dynamic> json) PageData<AlarmInfo>
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>
parseBlobEntityInfoPageData(Map<String, dynamic> json) PageData<BlobEntityInfo>
parseContactBasedPageData(Map<String, dynamic> json) PageData<ContactBased<HasUuid>>
parseConverterPageData(Map<String, dynamic> json) PageData<Converter>
parseCustomerPageData(Map<String, dynamic> json) PageData<Customer>
parseDashboardInfoPageData(Map<String, dynamic> json) PageData<DashboardInfo>
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>
parseEdgePageData(Map<String, dynamic> json) PageData<Edge>
parseEntityDataPageData(Map<String, dynamic> json) PageData<EntityData>
parseEntityVersionPageData(Map<String, dynamic> json) PageData<EntityVersion>
parseEntityViewPageData(Map<String, dynamic> json) PageData<EntityView>
parseIntegrationPageData(Map<String, dynamic> json) PageData<Integration>
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>
parseRolePageData(Map<String, dynamic> json) PageData<Role>
parseRpcPageData(Map<String, dynamic> json) PageData<Rpc>
parseRuleChainPageData(Map<String, dynamic> json) PageData<RuleChain>
parseRuleChainsList(List json) List<RuleChain>
parseShortEntityViewPageData(Map<String, dynamic> json) PageData<ShortEntityView>
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
resourceFromString(String value) Resource
resourceTypeFromString(String value) ResourceType
roleTypeFromString(String value) RoleType
rpcStatusFromString(String value) RpcStatus
ruleChainTypeFromString(String value) RuleChainType
schedulerRepeatTypeFromString(String value) SchedulerRepeatType
schedulerTimeUnitFromString(String value) SchedulerTimeUnit
schemeTypeFromString(String value) SchemeType
signUpResultFromString(String value) SignUpResult
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()

Exceptions / Errors

ThingsboardError