.. index:: 
  !Field Class

.. _id3_bioseal_field_class:

===============================================================================
Field Class
===============================================================================

Namespace: :ref:`id3.Bioseal<reference_bioseal>`

.. toctree::
  :hidden:

  containsBiometricData<contains_biometric_data>
  containsBiometrics<contains_biometrics>
  containsExtension<contains_extension>
  containsExtensionByName<contains_extension_by_name>
  containsKey<contains_key>
  count<count>
  extensionType<extension_type>
  fieldExtension<field_extension>
  fieldType<field_type>
  get<get>
  getBinaryAtIndex<get_binary_at_index>
  getCount<get_count>
  getLocalizedLabel<get_localized_label>
  getLocalizedValue<get_localized_value>
  getObjectAtIndex<get_object_at_index>
  isNull<is_null>
  keys<keys>
  name<name>
  setTimeZoneOffset<set_time_zone_offset>
  valueAsBinary<value_as_binary>
  valueAsBoolean<value_as_boolean>
  valueAsBooleanArray<value_as_boolean_array>
  valueAsDate<value_as_date>
  valueAsDateTime<value_as_date_time>
  valueAsDateTimeArray<value_as_date_time_array>
  valueAsFloat<value_as_float>
  valueAsFloatArray<value_as_float_array>
  valueAsInteger<value_as_integer>
  valueAsIntegerArray<value_as_integer_array>
  valueAsString<value_as_string>
  valueAsStringArray<value_as_string_array>
  valueAsTime<value_as_time>
  valueAsTimestamp<value_as_timestamp>
  valueAsTimestampArray<value_as_timestamp_array>
  visibilityCondition<visibility_condition>


Definition
----------
.. line-block::
    Represents a field or a dictionary of fields.


Properties
----------

.. list-table:: 
  :width: 100%
  :widths: 30 5 65
  :header-rows: 1

  * - Name
    - Type
    - Description
  * - :ref:`count<id3_bioseal_field_count_class_member>`
    - int
    - Gets the number of elements contained in the dict
  * - :ref:`containsBiometrics<id3_bioseal_field_contains_biometrics_class_member>`
    - bool
    - A value indicating whether the field (or one of its child fields) contains biometric data.
  * - :ref:`extensionType<id3_bioseal_field_extension_type_class_member>`
    - :ref:`FieldExtensionType<id3_bioseal_field_extension_type_enum>`
    - The field extension type.
  * - :ref:`fieldExtension<id3_bioseal_field_field_extension_class_member>`
    - :ref:`Extension<id3_bioseal_extension_class>`
    - The field extension.
  * - :ref:`fieldType<id3_bioseal_field_field_type_class_member>`
    - :ref:`FieldType<id3_bioseal_field_type_enum>`
    - The field type.
  * - :ref:`isNull<id3_bioseal_field_is_null_class_member>`
    - bool
    - A value indicating whether if the field is null.
  * - :ref:`keys<id3_bioseal_field_keys_class_member>`
    - :ref:`StringArray<id3_bioseal_string_array_class>`
    - Gets a string list containing the keys in the dict.
  * - :ref:`name<id3_bioseal_field_name_class_member>`
    - string
    - The field name.
  * - :ref:`valueAsBinary<id3_bioseal_field_value_as_binary_class_member>`
    - byte[]
    - The data as a binary array.
  * - :ref:`valueAsBoolean<id3_bioseal_field_value_as_boolean_class_member>`
    - bool
    - The field value as a boolean.
  * - :ref:`valueAsBooleanArray<id3_bioseal_field_value_as_boolean_array_class_member>`
    - bool[]
    - The field value as an array of booleans.
  * - :ref:`valueAsDate<id3_bioseal_field_value_as_date_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The field value as a date.
  * - :ref:`valueAsDateTime<id3_bioseal_field_value_as_date_time_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The field value as a date/time.
  * - :ref:`valueAsDateTimeArray<id3_bioseal_field_value_as_date_time_array_class_member>`
    - :ref:`DateTimeArray<id3_bioseal_date_time_array_class>`
    - The field value as an array of dates.
  * - :ref:`valueAsFloat<id3_bioseal_field_value_as_float_class_member>`
    - float
    - The field value as a float.
  * - :ref:`valueAsFloatArray<id3_bioseal_field_value_as_float_array_class_member>`
    - float[]
    - The field value as an array of floats.
  * - :ref:`valueAsInteger<id3_bioseal_field_value_as_integer_class_member>`
    - long
    - The field value as a 64-bit integer.
  * - :ref:`valueAsIntegerArray<id3_bioseal_field_value_as_integer_array_class_member>`
    - long[]
    - The field value as an array of 64-bit integers.
  * - :ref:`valueAsString<id3_bioseal_field_value_as_string_class_member>`
    - string
    - The field value as a string.
  * - :ref:`valueAsStringArray<id3_bioseal_field_value_as_string_array_class_member>`
    - :ref:`StringArray<id3_bioseal_string_array_class>`
    - The field value as an array of strings.
  * - :ref:`valueAsTime<id3_bioseal_field_value_as_time_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The field value as a time.
  * - :ref:`valueAsTimestamp<id3_bioseal_field_value_as_timestamp_class_member>`
    - long
    - The field value as a timestamp (without timezone computation).
  * - :ref:`valueAsTimestampArray<id3_bioseal_field_value_as_timestamp_array_class_member>`
    - long[]
    - The field value as an array of timestamp.
  * - :ref:`visibilityCondition<id3_bioseal_field_visibility_condition_class_member>`
    - :ref:`VisibilityCondition<id3_bioseal_visibility_condition_enum>`
    - The visibility condition.
  * - operator [string key]
    - :ref:`Field<id3_bioseal_field_class>`
    - 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
-------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`containsBiometricData<id3_bioseal_field_contains_biometric_data_class_method>`
    - Returns a value indicating whether the field (or one of its child fields) contains biometric data of the specified type and/or format.
  * - :ref:`containsExtension<id3_bioseal_field_contains_extension_class_method>`
    - Returns a value indicating whether the field (or one of its child fields) contains an extension of the specified type.
  * - :ref:`containsExtensionByName<id3_bioseal_field_contains_extension_by_name_class_method>`
    - Returns a value indicating whether the field (or one of its child fields) contains an extension with specified name.
  * - :ref:`containsKey<id3_bioseal_field_contains_key_class_method>`
    - Determines whether the Fieldobject contains the specified key.
  * - :ref:`get<id3_bioseal_field_get_class_method>`
    - Gets an item of the Field object.
  * - :ref:`getBinaryAtIndex<id3_bioseal_field_get_binary_at_index_class_method>`
    - Gets the binary data at the specified index.
  * - :ref:`getCount<id3_bioseal_field_get_count_class_method>`
    - Gets the number of elements in the Field object.
  * - :ref:`getLocalizedLabel<id3_bioseal_field_get_localized_label_class_method>`
    - Retrieves the localized label based on the provided language code.
  * - :ref:`getLocalizedValue<id3_bioseal_field_get_localized_value_class_method>`
    - Retrieves the localized value based on the provided language code.
  * - :ref:`getObjectAtIndex<id3_bioseal_field_get_object_at_index_class_method>`
    - Gets the object at the specified index.
  * - :ref:`setTimeZoneOffset<id3_bioseal_field_set_time_zone_offset_class_method>`
    - Set the time zone offset in seconds.
