Gjsify LogoGjsify Logo

A structure representing an information about a contact. Similar to a vCard field.

record

Hierarchy

  • ContactInfoField

Index

Constructors

  • new ContactInfoField(field_name: string, parameters: string[], field_value: string[]): ContactInfoField
  • Parameters

    • field_name: string

      The name of the field; this is the lowercased name of a vCard field. For example, a field representing a contact's address would be named "adr".

    • parameters: string[]

      A list of vCard type parameters applicable to this field, with their values. The type parameter names, and any values that are case-insensitive in vCard, MUST be in lower case. For example, a contact's preferred home address would have parameters 'type=home' and 'type=pref'.

    • field_value: string[]

      For unstructured vCard fields (such as 'fn', a formatted name field), a single-element array containing the field's value. For structured fields (such as 'adr', an address field), an array corresponding to the semicolon-separated elements of the field (with empty strings for empty elements).

    Returns ContactInfoField

Properties

field_name: string

The name of the field; this is the lowercased name of a vCard field. For example, a field representing a contact's address would be named "adr".

field
field_value: string[]

For unstructured vCard fields (such as 'fn', a formatted name field), a single-element array containing the field's value. For structured fields (such as 'adr', an address field), an array corresponding to the semicolon-separated elements of the field (with empty strings for empty elements).

field
parameters: string[]

A list of vCard type parameters applicable to this field, with their values. The type parameter names, and any values that are case-insensitive in vCard, MUST be in lower case. For example, a contact's preferred home address would have parameters 'type=home' and 'type=pref'.

field
name: string

Methods

  • new(field_name: string, parameters: string[], field_value: string[]): ContactInfoField
  • Parameters

    • field_name: string

      The name of the field; this is the lowercased name of a vCard field. For example, a field representing a contact's address would be named "adr".

    • parameters: string[]

      A list of vCard type parameters applicable to this field, with their values. The type parameter names, and any values that are case-insensitive in vCard, MUST be in lower case. For example, a contact's preferred home address would have parameters 'type=home' and 'type=pref'.

    • field_value: string[]

      For unstructured vCard fields (such as 'fn', a formatted name field), a single-element array containing the field's value. For structured fields (such as 'adr', an address field), an array corresponding to the semicolon-separated elements of the field (with empty strings for empty elements).

    Returns ContactInfoField

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