Field Class

Namespace: id3.Bioseal

Definition

Represents a field or a dictionary of fields.

Python

class Field

Dart

class Field implements Finalizable

C#

public partial class Field

Java

public class Field implements AutoCloseable, Serializable

Swift

public class Field

C

typedef struct id3BiosealField *ID3_BIOSEAL_FIELD;

Usage

Python

fieldInstance = id3bioseal.Field()

Explicit destruction

# ...
del fieldInstance

Dart

final fieldInstance = sdk.Field();
// ...

Explicit destruction

// ...
fieldInstance.dispose()

C#

using (var fieldInstance = new Field())
{
   // ...
}

Explicit destruction

var fieldInstance = new Field()
// ...
fieldInstance.Dispose()

Java

try (Field fieldInstance = new Field()) {
// ...
}

Explicit destruction

Field fieldInstance = new Field();
// ...
fieldInstance.close();

Swift

private var fieldInstance: Field? = nil
fieldInstance = try Field()

C

ID3_BIOSEAL_FIELD hField{};
int err = id3BiosealField_Initialize(&hField);
if (err == ID3_SUCCESS) {
    // ...
    id3BiosealField_Dispose(&hField);
}

Properties

Name	Type	Description
count	int	Gets the number of elements contained in the dict
containsBiometrics	bool	A value indicating whether the field (or one of its child fields) contains biometric data.
extensionType	FieldExtensionType	The field extension type.
fieldExtension	Extension	The field extension.
fieldType	FieldType	The field type.
isNull	bool	A value indicating whether if the field is null.
keys	StringArray	Gets a string list containing the keys in the dict.
name	string	The field name.
valueAsBinary	byte[]	The data as a binary array.
valueAsBoolean	bool	The field value as a boolean.
valueAsBooleanArray	bool[]	The field value as an array of booleans.
valueAsDate	DateTime	The field value as a date.
valueAsDateTime	DateTime	The field value as a date/time.
valueAsDateTimeArray	DateTimeArray	The field value as an array of dates.
valueAsFloat	float	The field value as a float.
valueAsFloatArray	float[]	The field value as an array of floats.
valueAsInteger	long	The field value as a 64-bit integer.
valueAsIntegerArray	long[]	The field value as an array of 64-bit integers.
valueAsString	string	The field value as a string.
valueAsStringArray	StringArray	The field value as an array of strings.
valueAsTime	DateTime	The field value as a time.
valueAsTimestamp	long	The field value as a timestamp (without timezone computation).
valueAsTimestampArray	long[]	The field value as an array of timestamp.
visibilityCondition	VisibilityCondition	The visibility condition.
operator [string key]	Field	Gets or sets the element for the key in the dict.

Iteration

This class supports iteration in Dart, C#, Java and Python.

The iteration is done on keys

Methods

Name	Description
containsBiometricData	Returns a value indicating whether the field (or one of its child fields) contains biometric data of the specified type and/or format.
containsExtension	Returns a value indicating whether the field (or one of its child fields) contains an extension of the specified type.
containsExtensionByName	Returns a value indicating whether the field (or one of its child fields) contains an extension with specified name.
containsKey	Determines whether the Fieldobject contains the specified key.
get	Gets an item of the Field object.
getBinaryAtIndex	Gets the binary data at the specified index.
getCount	Gets the number of elements in the Field object.
getLocalizedLabel	Retrieves the localized label based on the provided language code.
getLocalizedValue	Retrieves the localized value based on the provided language code.
getObjectAtIndex	Gets the object at the specified index.
setTimeZoneOffset	Set the time zone offset in seconds.