CarpDataEndPoint class - carp_backend library

Constructors

CarpDataEndPoint({required CarpUploadMethod uploadMethod, required String name, String? uri, String? clientId, String? clientSecret, String? email, String? password, String? collection, bool deleteWhenUploaded = true, String dataFormat = NameSpace.CARP, int bufferSize = 500 * 1000, bool zip = true, bool encrypt = false, String? publicKey}): Creates a CarpDataEndPoint.
CarpDataEndPoint.fromCarpApp({required CarpUploadMethod uploadMethod, required String name, String? collection, bool deleteWhenUploaded = true, String dataFormat = NameSpace.CARP, int bufferSize = 500 * 1000, bool zip = true, bool encrypt = false, String? publicKey, required CarpApp app}): Creates a CarpDataEndPoint based on a CarpApp app.
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
bufferSize ↔ int: The buffer size of the raw JSON file in bytes.
getter/setter pairinherited
clientId ↔ String?: The CARP web service client ID
getter/setter pair
clientSecret ↔ String?: The CARP web service client secret
getter/setter pair
collection ↔ String: When uploading to the CARP using the CarpUploadMethod.DOCUMENT method, collection hold the name of the collection to store json objects.
getter/setter pair
dataFormat ↔ String: The preferred format of the data to be uploaded according to NameSpace. Default using the NameSpace.CARP.
getter/setter pairinherited
deleteWhenUploaded ↔ bool: When uploading to CARP using file in the CarpUploadMethod.BATCH_DATA_POINT or CarpUploadMethod.FILE methods, specifies if the local file on the phone should be deleted once uploaded.
getter/setter pair
email ↔ String?: Email used as username in password authentication.
getter/setter pair
encrypt ↔ bool: Is data to be encrypted before storing. False as default.
getter/setter pairinherited
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: The name of the CARP endpoint. Can be anything, but its recommended to name it according to the CARP service name.
getter/setter pair
password ↔ String?: Password used in password authentication.
getter/setter pair
publicKey ↔ String?: If encrypt is true, this should hold the public key in a RSA KPI encryption of data.
getter/setter pairinherited
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
uploadMethod ↔ CarpUploadMethod: The method used to upload to CARP. See CarpUploadMethod for options.
getter/setter pair
uri ↔ String?: The URI of the CARP endpoint.
getter/setter pair
zip ↔ bool: Is data to be compressed (zipped) before storing in a file. True as default.
getter/setter pairinherited

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

Constants

DEFAULT_COLLECTION → const String: The default collection name.