format method

String format({
  1. List<AddressField>? excludeFields,
  2. List<AddressField>? includeFields,
})

Formats the address as a string.

Parameters

  • IN excludeFields Fields to be excluded from result. If not specified nothing is excluded.
  • IN includeFields Fields to be included from result. If not specified all are included.

Returns

  • Formatted string

Throws

  • An exception if it fails.

Implementation

String format({
  final List<AddressField>? excludeFields,
  final List<AddressField>? includeFields,
}) {
  final OperationResult resultString = objectMethod(
    _pointerId,
    'AddressInfo',
    'format',
    args: <String, dynamic>{
      if (excludeFields != null)
        'excludeFields':
            excludeFields.map((final AddressField e) => e.id).toList(),
      if (includeFields != null)
        'includeFields':
            includeFields.map((final AddressField e) => e.id).toList(),
    },
  );

  return resultString['result'];
}