Class VCard

Hierarchy

  • VCard

Constructors

constructor

Properties

add addBirthday addCode addCountry addEmail addFirstname addFullName addGender addGenderIdentity addLastname addLocality addNamePrefix addNameSuffix addNote addRegion addStreet addTelephone combine equals get toXML toXMLString fromXML

Accessors

birthday code country email firstname fullName gender genderIdentity items lastname locality namePrefix nameSuffix note region street telephone

Constructors

constructor

Properties

add

add: ((key: string, value: any) => VCard)

Type declaration

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

    • A generic function for adding additional VCard elements

      Returns

      VCard for chaining function calls

      Parameters

      • key: string

        The VCard's value identifier

      • value: any

        The value itself

      Returns VCard

addBirthday

addBirthday: ((value: Date) => VCard)

Type declaration

    • (value: Date): VCard

    • The VCard's bday object

      Returns

      VCard for chaining function calls

      Parameters

      • value: Date

      Returns VCard

addCode

addCode: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addCountry

addCountry: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addEmail

addEmail: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's email object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addFirstname

addFirstname: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's surname object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addFullName

addFullName: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's fn object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addGender

addGender: ((value: Gender) => VCard)

Type declaration

    • (value: Gender): VCard

    • The VCard's gender/sex object

      Returns

      VCard for chaining function calls

      Parameters

      Returns VCard

addGenderIdentity

addGenderIdentity: ((value: string) => VCard)

Type declaration

addLastname

addLastname: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's given object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addLocality

addLocality: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addNamePrefix

addNamePrefix: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's prefix object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addNameSuffix

addNameSuffix: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's suffix object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addNote

addNote: ((value: string) => VCard)

Type declaration

    • (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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addRegion

addRegion: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addStreet

addStreet: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

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

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

addTelephone

addTelephone: ((value: string) => VCard)

Type declaration

    • (value: string): VCard

    • The VCard's tel object

      Returns

      VCard for chaining function calls

      Parameters

      • value: string

      Returns VCard

combine

combine: ((other: VCard) => void)

Type declaration

    • (other: VCard): void

    • Parameters

      Returns void

equals

equals: ((vCard: VCard) => boolean)

Type declaration

    • (vCard: VCard): boolean

    • Parameters

      Returns boolean

get

get: ((key: string) => any)

Type declaration

    • (key: string): any

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

      Returns

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

      Parameters

      • key: string

        The VCard value's key

      Returns any

toXML

toXML: ((namespacePrefix?: string) => XMLDocument)

Type declaration

toXMLString

toXMLString: ((namespacePrefix?: string) => string)

Type declaration

    • (namespacePrefix?: string): string

    • Parameters

      • Optional namespacePrefix: string

      Returns string

Static fromXML

fromXML: ((xml: string) => VCard)

Type declaration

    • (xml: string): VCard

    • Parameters

      • xml: string

      Returns VCard

Accessors

birthday

  • get birthday(): undefined | Date

  • Returns undefined | Date

code

  • get code(): undefined | string

  • Returns undefined | string

country

  • get country(): undefined | string

  • Returns undefined | string

email

  • get email(): undefined | string

  • Returns undefined | string

firstname

  • get firstname(): undefined | string

  • Returns undefined | string

fullName

  • get fullName(): undefined | string

  • Returns undefined | string

gender

  • get gender(): undefined | Gender

  • Returns undefined | Gender

genderIdentity

  • get genderIdentity(): undefined | string

  • Returns undefined | string

items

  • get items(): KeyValue[]

  • Returns KeyValue[]

lastname

  • get lastname(): undefined | string

  • Returns undefined | string

locality

  • get locality(): undefined | string

  • Returns undefined | string

namePrefix

  • get namePrefix(): undefined | string

  • Returns undefined | string

nameSuffix

  • get nameSuffix(): undefined | string

  • Returns undefined | string

note

  • get note(): undefined | string

  • Returns undefined | string

region

  • get region(): undefined | string

  • Returns undefined | string

street

  • get street(): undefined | string

  • Returns undefined | string

telephone

  • get telephone(): undefined | string

  • Returns undefined | string

Settings

Member Visibility

Theme

Generated using TypeDoc