DocumentPhoneNumberField.yml

### YamlMime:TSType
name: DocumentPhoneNumberField
uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField'
package: '@azure/ai-form-recognizer'
summary: A DocumentField that has a phone number value, represented as a string.
fullName: DocumentPhoneNumberField
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: kind
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.kind'
    package: '@azure/ai-form-recognizer'
    summary: 'Field kind: "phoneNumber".'
    fullName: kind
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'kind: "phoneNumber"'
      return:
        description: ''
        type: '"phoneNumber"'
  - name: value
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.value'
    package: '@azure/ai-form-recognizer'
    summary: >-
      The field's value, which is a string containing the phone number.


      The phone number value is normalized to a standard format. If the value
      could not be normalized, this value may be

      undefined, and the `content` property will contain the verbatim text of
      the DocumentField as it appeared in the

      input.
    fullName: value
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'value?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: boundingRegions
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.boundingRegions'
    package: '@azure/ai-form-recognizer'
    summary: Bounding regions covering the field.
    fullName: boundingRegions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'boundingRegions?: BoundingRegion[]'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.BoundingRegion" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.boundingRegions](xref:@azure/ai-form-recognizer.DocumentFieldCommon.boundingRegions)
  - name: confidence
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.confidence'
    package: '@azure/ai-form-recognizer'
    summary: Confidence of correctly extracting the field.
    fullName: confidence
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'confidence?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.confidence](xref:@azure/ai-form-recognizer.DocumentFieldCommon.confidence)
  - name: content
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.content'
    package: '@azure/ai-form-recognizer'
    summary: The verbatim extracted text content of the field.
    fullName: content
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'content?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.content](xref:@azure/ai-form-recognizer.DocumentFieldCommon.content)
  - name: spans
    uid: '@azure/ai-form-recognizer.DocumentPhoneNumberField.spans'
    package: '@azure/ai-form-recognizer'
    summary: Location of the field in the reading order concatenated content.
    fullName: spans
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'spans?: DocumentSpan[]'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.DocumentSpan" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.spans](xref:@azure/ai-form-recognizer.DocumentFieldCommon.spans)
extends: <xref uid="@azure/ai-form-recognizer.DocumentFieldCommon" />