Class AnnotatedObjectField

constructor

• new AnnotatedObjectField(serverResponse: StringDict): AnnotatedObjectField

  Parameters

  • serverResponse: StringDict

  Returns AnnotatedObjectField

Readonlyfields

getListField

• getListField(fieldName: string): AnnotatedListField

  Retrieves a AnnotatedListField by its name if it exists and is of the correct type.

  Parameters

  • fieldName: string

    The name of the field to retrieve.

  Returns AnnotatedListField

  The field instance if it exists and is valid, or undefined if not.

  Throws

  If the field does not exist or is of wrong type.

getObjectField

• getObjectField(fieldName: string): AnnotatedObjectField

  Retrieves an AnnotatedObjectField by its name if it exists and is of the correct type.

  Parameters

  • fieldName: string

    The name of the field to retrieve.

  Returns AnnotatedObjectField

  The field instance if it exists and is valid, or undefined if not.

  Throws

  If the field does not exist or is of wrong type.

getSimpleField

• getSimpleField(fieldName: string): AnnotatedSimpleField

  Retrieves a AnnotatedSimpleField by its name if it exists and is of the correct type.

  Parameters

  • fieldName: string

    The name of the field to retrieve.

  Returns AnnotatedSimpleField

  The field instance if it exists and is valid, or undefined if not.

  Throws

  If the field does not exist or is of wrong type.

toStringFromList

• toStringFromList(): string

  Returns a compact representation suitable for list items.

  Returns string