Properties

• After documenting the property value data types and the property parameters, what follows now is the documentation of the properties themselves

• According to the RFC, the following are the properties:

  • General Properties

    1. BEGIN
    2. END
    3. SOURCE
    4. KIND
    5. XML

  • Identification Properties

    1. FN
    2. N
    3. NICKNAME
    4. PHOTO
    5. BDAY
    6. ANNIVERSARY
    7. GENDER
    8. BIRTHPLACE
    9. DEATHPLACE
    10. DEATHDATE
    11. EXPERTISE
    12. HOBBY
    13. INTEREST

  • Delivery Addressing Properties

    1. ADR

  • Communications Properties

    1. TEL
    2. EMAIL
    3. IMPP
    4. LANG
    5. CONTACT-URI

  • Geographical Properties

    1. TZ
    2. GEO

  • Organizational Properties

    1. TITLE
    2. ROLE
    3. LOGO
    4. ORG
    5. MEMBER
    6. RELATED
    7. ORG-DIRECTORY

  • Explanatory Properties

    1. CATEGORIES
    2. NOTE
    3. PRODID
    4. REV
    5. SOUND
    6. UID
    7. CLIENTPIDMAP
    8. URL
    9. VERSION

  • Security Properties

    1. KEY

  • Calendar Properties

    1. FBURL
    2. CALADRURI
    3. CALURI

  • Extended Properties

info

vcard4 treats BEGIN, VERSION and END properties as special. You do not construct them manually as you do the other properties, it adds them to the constructed vCard itself.

• In the library, they are represented by the following classes:

  1. SourceProperty
  2. KindProperty
  3. XMLProperty
  4. FNProperty
  5. NProperty
  6. NicknameProperty
  7. PhotoProperty
  8. BdayProperty
  9. AnniversaryProperty
  10. GenderProperty
  11. BirthPlaceProperty
  12. DeathPlaceProperty
  13. DeathDateProperty
  14. ExpertiseProperty
  15. HobbyProperty
  16. InterestProperty
  17. AdrProperty
  18. TelProperty
  19. EmailProperty
  20. IMPPProperty
  21. LangProperty
  22. ContactURIProperty
  23. TzProperty
  24. GeoProperty
  25. TitleProperty
  26. RoleProperty
  27. LogoProperty
  28. OrgProperty
  29. MemberProperty
  30. RelatedProperty
  31. OrgDirectoryProperty
  32. CategoriesProperty
  33. NoteProperty
  34. ProdidProperty
  35. RevProperty
  36. SoundProperty
  37. UIDProperty
  38. ClientpidmapProperty
  39. URLProperty
  40. KeyProperty
  41. FburlProperty
  42. CaladruriProperty
  43. CaluriProperty
  44. ExtendedProperty

• The instance object is frozen and therefore its properties and methods cannot be modified after construction, neither can new ones be added

tip

All of the classes, with the exception of a few, should generally be called with two arguments, the first being an array whose items are the parameters of the property and the second argument being the property's value.

API

• All the classes listed above are provided as named exports from the main vcard4 module. For example, to import the AdrProperty class:

  ESM

  import { AdrProperty } from "vcard4";
  commonjs

  const { AdrProperty } = require("vcard4");

Methods

• The instance objects have the following methods:

  1. repr

  This method returns a string which is the representation of how the property will finally appear in the vCard.

  note

  '>' in the examples below is just the terminal prompt.

  > const genderPropValue = new SpecialValueType(
  >   'GenderProperty',
  >   [
  >     new SexType('M'),
  >     new TextType('Male')
  >   ],
  > );
  
  > const genderPropValueParam = new ValueParameter(genderPropValue);
  
  > const gender = new GenderProperty(
  >   [ genderPropValueParam ],
  >   genderPropValue
  > );
  
  > gender.repr();
  'GENDER;VALUE=text:M;Male'
  2. reprXML

  This method returns a string which is the representation of how the property will finally appear in the XML vCard.

  > const genderPropValue = new SpecialValueType(
  >   'GenderProperty',
  >  [
  >    new SexType('M'),
  >    new TextType('Male')
  >  ],
  > );
  
  > const genderPropValueParam = new ValueParameter(genderPropValue);
  
  > const gender = new GenderProperty(
  >  [ genderPropValueParam ],
  >  genderPropValue
  > );
  
  > gender.reprXML();
  '<gender><sex>M</sex><text>Male</text></gender>'
  3. reprJSON

  This method returns an array showing how the property will finally appear in the jCard.

  > const genderPropValue = new SpecialValueType(
  >   'GenderProperty',
  >   [
  >     new SexType('M'),
  >     new TextType('Male')
  >   ],
  > );
  
  > const genderPropValueParam = new ValueParameter(genderPropValue);
  
  > const gender = new GenderProperty(
  >   [ genderPropValueParam ],
  >   genderPropValue
  > );
  
  > gender.reprJSON();
  [ 'gender', {}, 'text', [ 'M', 'Male' ] ]