thingsboard_pe_client library Null safety

Dart implementation of ThingsBoard API client.

Classes

AbstractDataQuery<T extends EntityDataPageLink>
AdditionalInfoBased<T extends HasUuid>
AdminService
AdminSettings
AdminSettingsId
Alarm
AlarmData
AlarmDataCmd
AlarmDataQuery
AlarmDataUnsubscribeCmd
AlarmDataUpdate
AlarmId
AlarmInfo
AlarmQuery
AlarmService
AllowedPermissionsInfo
ApiUsageStateFilter
ApiUsageStateId
Asset
AssetId
AssetSearchQuery
AssetSearchQueryFilter
AssetService
AssetTypeFilter
AttributeData
AttributeKvEntry
AttributesEntityView
AttributeService
AttributesSubscriptionCmd
AuditLog
AuditLogId
AuditLogService
AuthUser
AwsSnsSmsProviderConfiguration
BaseAttributeKvEntry
BaseData<T extends HasUuid>
BaseEventBody
BaseWidgetType
BasicKvEntry
BasicTsKvEntry
BlobEntityId
BlobEntityInfo
BlobEntityService
BlobEntityWithCustomerInfo
BooleanDataEntry
BooleanFilterPredicate
ClaimRequest
ClaimResult
CmdUpdate
CoapDeviceProfileTransportConfiguration
CoapDeviceTransportConfiguration
ComplexFilterPredicate
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
DeviceId
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
EntitiesByGroupNameFilter
EntityCountCmd
EntityCountQuery
EntityCountUnsubscribeCmd
EntityCountUpdate
EntityData
EntityDataCmd
EntityDataQuery
EntityDataSortOrder
EntityDataUnsubscribeCmd
EntityDataUpdate
EntityFilter
EntityGroup
EntityGroupFilter
EntityGroupId
EntityGroupInfo
EntityGroupListFilter
EntityGroupNameFilter
EntityGroupService
EntityHistoryCmd
EntityId
EntityInfo
EntityKey
EntityListFilter
EntityNameFilter
EntityQueryService
EntityRelation
EntityRelationInfo
EntityRelationService
EntityRelationsQuery
EntitySearchQuery
EntitySearchQueryFilter
EntitySubtype
EntityTypeFilter
EntityView
EntityViewId
EntityViewSearchQuery
EntityViewSearchQueryFilter
EntityViewService
EntityViewTypeFilter
ErrorEventBody
Event
EventBody
EventId
Favicon
FilterPredicateValue<T>
GeneralSettings
GenericRolePermissions
GetHistoryCmd
GroupPermission
GroupPermissionId
GroupPermissionInfo
GroupPermissionService
HasAdditionalInfo
HasCustomerId
HasName
HasOtaPackage
HasTenantId
HasUuid
HomeDashboard
HomeDashboardInfo
InMemoryStorage
Integration
IntegrationId
IntegrationService
JsonDataEntry
KeyFilter
KeyFilterPredicate
KvEntry
LatestValueCmd
LcEventEventBody
LoginRequest
LoginResponse
LoginWhiteLabelingParams
LongDataEntry
Lwm2mDeviceProfileTransportConfiguration
Lwm2mDeviceTransportConfiguration
MailServerSettings
MergedGroupPermissionInfo
MergedGroupTypePermissionInfo
MergedUserPermissions
MqttDeviceProfileTransportConfiguration
MqttDeviceTransportConfiguration
NodeConnectionInfo
NumericFilterPredicate
OAuth2BasicMapperConfig
OAuth2ClientInfo
OAuth2ClientRegistrationTemplate
OAuth2ClientRegistrationTemplateId
OAuth2CustomMapperConfig
OAuth2DomainInfo
OAuth2Info
OAuth2MapperConfig
OAuth2MobileInfo
OAuth2ParamsInfo
OAuth2RegistrationInfo
OAuth2Service
OtaPackage
OtaPackageId
OtaPackageInfo
OtaPackageService
OwnerService
PageData<T>
Palette
PaletteSettings
RawEventBody
RefreshTokenRequest
RelationEntityTypeFilter
RelationsQueryFilter
RelationsSearchParameters
ReportConfig
ReportParams
ReportService
RequestConfig
ResourceService
RestJsonConverter
Role
RoleId
RolePermissions
RoleService
Rpc
RpcId
RuleChain
RuleChainConnectionInfo
RuleChainData
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
SmsProviderConfiguration
SnmpDeviceProfileTransportConfiguration
SnmpDeviceTransportConfiguration
SortOrder
SpecificRolePermissions
StateEntityOwnerFilter
StatsEventBody
StringDataEntry
StringFilterPredicate
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
TsKvEntry
TsValue
TwilioSmsProviderConfiguration
UpdateMessage
User
UserId
UserPasswordPolicy
UserPermissionsService
UserService
WebsocketCmd
WebsocketDataMsg
WhiteLabelingParams
WhiteLabelingService
WidgetsBundle
WidgetsBundleId
WidgetService
WidgetType
WidgetTypeDetails
WidgetTypeId
WidgetTypeInfo

Extensions

ActionStatusToString
ActionTypeToString
AggregationToString
AlarmSearchStatusToString
AlarmSeverityToString
AlarmStatusToString
AttributeScopeToString
AuthorityToString
BooleanOperationToString
ChecksumAlgorithmToString
ClaimResponseToString
CoapTransportDeviceTypeToString
ComplexOperationToString
ComponentScopeToString
ComponentTypeToString
ContentTypeToString
ConverterTypeToString
DataTypeToString
DeviceCredentialsTypeToString
DeviceProfileProvisionTypeToString
DeviceProfileTypeToString
DeviceTransportTypeToString
DirectionToString
DynamicValueSourceTypeToString
EdgeEventActionTypeToString
EdgeEventTypeToString
EntityDataSortOrderDirectionToString
EntityFilterTypeToString
EntityKeyTypeToString
EntityKeyValueTypeToString
EntitySearchDirectionToString
EntityTypeToString
FilterPredicateTypeToString
IntegrationTypeToString
LatestTelemetryToString
MapperTypeToString
NumericOperationToString
OperationToString
OtaPackageTypeToString
PlatformTypeToString
RelationTypeGroupToString
ResourceToString
ResourceTypeToString
RoleTypeToString
RpcStatusToString
RuleChainTypeToString
SchedulerRepeatTypeToString
SchedulerTimeUnitToString
SchemeTypeToString
SmtpProtocolToString
SSmsProviderTypeToString
StringOperationToString
TenantNameStrategyTypeToString
TenantProfileTypeToString
TransportPayloadTypeToString

Constants

ACTIVATE_TOKEN_REGEX → const String
'/api/noauth/activate?activateToken='
CONTAINS_TYPE → const String
'Contains'
entityFilterTypeToStringMap → const Map<EntityFilterType, String>
{EntityFilterType.SINGLE_ENTITY : 'singleEntity', EntityFilterType.ENTITY_GROUP : 'entityGroup', EntityFilterType.ENTITY_LIST : 'entityList', EntityFilterType.ENTITY_NAME : …
groupResourceByGroupType → const Map<EntityType, Resource>
<EntityType, Resource>{EntityType.CUSTOMER : Resource.CUSTOMER_GROUP, EntityType.DEVICE : Resource.DEVICE_GROUP, EntityType.ASSET : Resource.ASSET_GROUP, EntityType.USER : Resource.USER_GROUP, E…
MANAGES_TYPE → const String
'Manages'
MAX_PUBLISH_COMMANDS → const int
10
nullUuid → const String
'13814000-1dd2-11b2-8080-808080808080'
RECONNECT_INTERVAL → const int
2000
resourceByEntityType → const Map<EntityType, Resource>
<EntityType, Resource>{EntityType.ALARM : Resource.ALARM, EntityType.DEVICE : Resource.DEVICE, EntityType.DEVICE_PROFILE : Resource.DEVICE_PROFILE, EntityType.ASSET : Resource.ASSET, EntityType.…
WS_IDLE_TIMEOUT → const int
90000

Properties

stringToEntityFilterTypeMap Map<String, EntityFilterType>
read / write
syncCompute TbCompute
read / write

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
componentScopeFromString(String value) ComponentScope
componentTypeFromString(String value) ComponentType
contentTypeFromString(String value) ContentType
converterTypeFromString(String value) ConverterType
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
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
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>
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>
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>
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>
parseWidgetTypeInfosList(List json) List<WidgetTypeInfo>
parseWidgetTypeList(List json) List<WidgetType>
platformTypeFromString(String value) PlatformType
relationTypeGroupFromString(String value) RelationTypeGroup
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
tenantNameStrategyTypeFromString(String value) TenantNameStrategyType
tenantProfileTypeFromString(String value) TenantProfileType
toThingsboardError(dynamic error, [StackTrace? stackTrace]) ThingsboardError
transportPayloadTypeFromString(String value) TransportPayloadType

Enums

ActionStatus
ActionType
Aggregation
AlarmSearchStatus
AlarmSeverity
AlarmStatus
AttributeScope
Authority
BooleanOperation
ChecksumAlgorithm
ClaimResponse
CmdUpdateType
CoapTransportDeviceType
ComplexOperation
ComponentScope
ComponentType
ContentType
ConverterType
DataType
DeviceCredentialsType
DeviceProfileProvisionType
DeviceProfileType
DeviceTransportType
Direction
DynamicValueSourceType
EdgeEventActionType
EdgeEventType
EntityDataSortOrderDirection
EntityFilterType
EntityKeyType
EntityKeyValueType
EntitySearchDirection
EntityType
EventType
FilterPredicateType
IntegrationType
LatestTelemetry
MapperType
NumericOperation
Operation
OtaPackageType
PlatformType
RelationTypeGroup
Resource
ResourceType
RoleType
RpcStatus
RuleChainType
SchedulerRepeatType
SchedulerTimeUnit
SchemeType
SignUpResult
SmsProviderType
SmtpProtocol
StringOperation
TelemetryFeature
TenantNameStrategyType
TenantProfileType
TransportPayloadType

Typedefs

ErrorCallback = void Function(ThingsboardError error)
fromIdFunction<T> = T Function(String id)
fromJsonFunction<T> = T Function(dynamic json)
LoadFinishedCallback = void Function()
LoadStartedCallback = 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