Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VCard

Hierarchy

  • VCard

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

birthday

  • get birthday(): undefined | Date

code

  • get code(): undefined | string

country

  • get country(): undefined | string

email

  • get email(): undefined | string

firstname

  • get firstname(): undefined | string

fullName

  • get fullName(): undefined | string

gender

  • get gender(): undefined | Gender

genderIdentity

  • get genderIdentity(): undefined | string

lastname

  • get lastname(): undefined | string

locality

  • get locality(): undefined | string

namePrefix

  • get namePrefix(): undefined | string

nameSuffix

  • get nameSuffix(): undefined | string

note

  • get note(): undefined | string

region

  • get region(): undefined | string

street

  • get street(): undefined | string

telephone

  • get telephone(): undefined | string

Methods

add

  • add(key: string, value: any): VCard

  • A generic function for adding additional VCard elements

    Parameters

    • key: string

      The VCard's value identifier

    • value: any

      The value itself

    Returns VCard

    VCard for chaining function calls

addBirthday

  • addBirthday(value: Date): VCard

addCode

  • addCode(value: string): VCard

  • The VCard's adr code object e.g. the postal code

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addCountry

  • addCountry(value: string): VCard

  • The VCard's adr country object e.g. the country name

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addEmail

  • addEmail(value: string): VCard

addFirstname

  • addFirstname(value: string): VCard

addFullName

  • addFullName(value: string): VCard

addGender

addGenderIdentity

  • addGenderIdentity(value: string): VCard

addLastname

  • addLastname(value: string): VCard

addLocality

  • addLocality(value: string): VCard

  • The VCard's adr locality object e.g. city

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addNamePrefix

  • addNamePrefix(value: string): VCard

addNameSuffix

  • addNameSuffix(value: string): VCard

addNote

  • addNote(value: string): VCard

  • The VCard's note object e.g. any arbitrary additional information Can also be a JSON or XML encoded string for passing structured data

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addRegion

  • addRegion(value: string): VCard

  • The VCard's adr region object e.g. state or province

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addStreet

  • addStreet(value: string): VCard

  • The VCard's adr street object e.g. the street address

    Parameters

    • value: string

    Returns VCard

    VCard for chaining function calls

addTelephone

  • addTelephone(value: string): VCard

combine

  • combine(other: VCard): void

equals

  • equals(vCard: VCard): boolean

get

  • get(key: string): any

  • A generic function for retrieving a VCard element's value

    Parameters

    • key: string

      The VCard value's key

    Returns any

    The VCard element's value, or undefined, if not found

toXML

toXMLString

  • toXMLString(namespacePrefix?: string): string

Static fromXML

  • fromXML(xml: string): VCard

Generated using TypeDoc