Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

address?: string

The postal address itself, formatted and unstructured. It is preferred to use the other, structured properties rather than this one.

For more information, see the GData specification.

agent?: string

The agent who actually receives the mail. Used in work addresses. Also for "in care of" or "c/o".

For more information, see the GData specification.

city?: string

Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.

For more information, see the GData specification.

constructed_from_xml?: boolean

Specifies whether the object was constructed by parsing XML or manually.

house_name?: string

Used in places where houses or buildings have names (and not necessarily numbers).

For more information, see the GData specification.

is_primary?: boolean

Indicates which postal address out of a group is primary.

For more information, see the GData specification.

label?: string

A simple string value used to name this postal address. It allows UIs to display a label such as "Work", "Personal", "Preferred", etc.

For more information, see the GData specification.

mail_class?: string

Classes of mail accepted at this address. For example: %GDATA_GD_MAIL_CLASS_LETTERS or %GDATA_GD_MAIL_CLASS_BOTH.

For more information, see the GData specification.

neighborhood?: string

This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town. In China it could be a county or a minor city.

For more information, see the GData specification.

po_box?: string

Covers actual P.O. boxes, drawers, locked bags, etc. This is usually but not always mutually exclusive with #GDataGDPostalAddress:street.

For more information, see the GData specification.

postcode?: string

Postal code. Usually country-wide, but sometimes specific to the city (e.g. "2" in "Dublin 2, Ireland" addresses).

For more information, see the GData specification.

region?: string

A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.

For more information, see the GData specification.

relation_type?: string

A programmatic value that identifies the type of postal address. For example: %GDATA_GD_POSTAL_ADDRESS_WORK or %GDATA_GD_POSTAL_ADDRESS_OTHER.

For more information, see the GData specification.

street?: string

Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.

For more information, see the GData specification.

subregion?: string

Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.

For more information, see the GData specification.

usage?: string

The context in which this address can be used. For example: %GDATA_GD_ADDRESS_USAGE_GENERAL or %GDATA_GD_ADDRESS_USAGE_LOCAL.

For more information, see the GData specification.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method