CarpDataEndPoint class
Specify a CARP Web Service (CAWS) endpoint for uploading data.
- Inheritance
-
- Object
- Serializable
- DataEndPoint
- CarpDataEndPoint
- Annotations
-
- @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)
Constructors
- CarpDataEndPoint({String dataFormat = NameSpace.CARP, String name = 'CARP Web Services', CarpUploadMethod uploadMethod = CarpUploadMethod.stream, bool onlyUploadOnWiFi = false, int uploadInterval = 10, bool deleteWhenUploaded = true})
- Creates a CarpDataEndPoint.
-
CarpDataEndPoint.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The runtime class name (type) of this object.
Used for deserialization from JSON objects.
getter/setter pairinherited
- dataFormat ↔ String
-
The preferred format of the data to be uploaded according to
NameSpace
. Default using theNameSpace.CARP
.getter/setter pairinherited - deleteWhenUploaded ↔ bool
-
Should the local buffered data on the phone be deleted once uploaded?
getter/setter pair
- fromJsonFunction → Function
-
The function which can convert a JSON string to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- jsonType → String
-
Return the
__type
to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.no setterinherited - name ↔ String
-
A printer-friendly name of the CAWS endpoint. Can be anything, but its
recommended to name it according to the CAWS service name.
getter/setter pair
- onlyUploadOnWiFi ↔ bool
-
Only upload when connected via WiFi network?
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type ↔ String
-
The type of endpoint as enumerated in
DataEndPointTypes
.getter/setter pairinherited - uploadInterval ↔ int
-
How often should data be uploaded. In minutes.
getter/setter pair
- uploadMethod ↔ CarpUploadMethod
-
The method used to upload to CARP. See CarpUploadMethod for options.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Return a JSON encoding of this object.
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited