Class VCard

Class representation of a vCard.

Example

const vCard = new VCard(Kind.Individual);
vCard.setFullName("Jane Doe");

vCard.toString();

Hierarchy

VCard

Implements

VCardDefinition
Omit<VCardGroupDefinition, "kind">

Index

Constructors

constructor

Constructors

constructor

new VCard(kind?: KindProperty<Kind>, fullName?: FullNameProperty): VCard
Create a new vCard instance.

Example
```
const vCard = new VCard(Kind.Individual);
vCard.setFullName("Jane Doe");
```
Parameters
- kind: KindProperty<Kind> = Kind.Individual
  
  the kind of the vCard.
- fullName: FullNameProperty = ""
  
  the full name of the vCard contact.
Returns VCard
- Defined in model/classes/VCard.ts:299

Properties

Accessors

`Experimental` abLabel

get abLabel(): undefined | ABLabelProperty
Experimental
Returns undefined | ABLabelProperty
Implementation of VCardDefinition.abLabel
- Defined in model/classes/VCard.ts:457

address

get address(): undefined | AddressProperty
Returns undefined | AddressProperty
Implementation of VCardDefinition.address
- Defined in model/classes/VCard.ts:340

`Experimental` album

get album(): undefined | AlbumProperty
Experimental
Returns undefined | AlbumProperty
Implementation of VCardDefinition.album
- Defined in model/classes/VCard.ts:448

anniversary

get anniversary(): undefined | AnniversaryProperty
Returns undefined | AnniversaryProperty
Implementation of VCardDefinition.anniversary
- Defined in model/classes/VCard.ts:334

begin

get begin(): undefined | BeginProperty
Returns undefined | BeginProperty
Implementation of VCardDefinition.begin
- Defined in model/classes/VCard.ts:304

birthPlace

get birthPlace(): undefined | BirthPlaceProperty
Returns undefined | BirthPlaceProperty
Implementation of VCardDefinition.birthPlace
- Defined in model/classes/VCard.ts:418

birthday

get birthday(): undefined | BirthdayProperty
Returns undefined | BirthdayProperty
Implementation of VCardDefinition.birthday
- Defined in model/classes/VCard.ts:331

calendarAddressUri

get calendarAddressUri(): undefined | CalendarAddressUriProperty
Returns undefined | CalendarAddressUriProperty
Implementation of VCardDefinition.calendarAddressUri
- Defined in model/classes/VCard.ts:409

calendarUri

get calendarUri(): undefined | CalendarUriProperty
Returns undefined | CalendarUriProperty
Implementation of VCardDefinition.calendarUri
- Defined in model/classes/VCard.ts:412

clientPidMap

get clientPidMap(): undefined | ClientPidMapDictionary | ClientPidMapProperty
Returns undefined | ClientPidMapDictionary | ClientPidMapProperty
Implementation of VCardDefinition.clientPidMap
- Defined in model/classes/VCard.ts:394

contactUri

get contactUri(): undefined | ContactUriProperty
Returns undefined | ContactUriProperty
Implementation of VCardDefinition.contactUri
- Defined in model/classes/VCard.ts:439

deathDate

get deathDate(): undefined | DeathDateProperty
Returns undefined | DeathDateProperty
Implementation of VCardDefinition.deathDate
- Defined in model/classes/VCard.ts:424

deathPlace

get deathPlace(): undefined | DeathPlaceProperty
Returns undefined | DeathPlaceProperty
Implementation of VCardDefinition.deathPlace
- Defined in model/classes/VCard.ts:421

`Experimental` depiction

get depiction(): undefined | DepictionProperty
Experimental
Returns undefined | DepictionProperty
Implementation of VCardDefinition.depiction
- Defined in model/classes/VCard.ts:451

email

get email(): undefined | EmailProperty
Returns undefined | EmailProperty
Implementation of VCardDefinition.email
- Defined in model/classes/VCard.ts:346

end

get end(): undefined | EndProperty
Returns undefined | EndProperty
Implementation of VCardDefinition.end
- Defined in model/classes/VCard.ts:307

expertise

get expertise(): undefined | ExpertiseProperty
Returns undefined | ExpertiseProperty
Implementation of VCardDefinition.expertise
- Defined in model/classes/VCard.ts:427

fbUrl

get fbUrl(): undefined | FbUrlProperty
Returns undefined | FbUrlProperty
Implementation of VCardDefinition.fbUrl
- Defined in model/classes/VCard.ts:406

fullName

get fullName(): FullNameProperty
Returns FullNameProperty
Implementation of VCardDefinition.fullName
- Defined in model/classes/VCard.ts:319

gender

get gender(): undefined | GenderProperty
Returns undefined | GenderProperty
Implementation of VCardDefinition.gender
- Defined in model/classes/VCard.ts:337

geoLocation

get geoLocation(): undefined | GeoLocationProperty
Returns undefined | GeoLocationProperty
Implementation of VCardDefinition.geoLocation
- Defined in model/classes/VCard.ts:358

hobby

get hobby(): undefined | HobbyProperty
Returns undefined | HobbyProperty
Implementation of VCardDefinition.hobby
- Defined in model/classes/VCard.ts:430

impp

get impp(): undefined | ImppProperty
Returns undefined | ImppProperty
Implementation of VCardDefinition.impp
- Defined in model/classes/VCard.ts:349

interest

get interest(): undefined | InterestProperty
Returns undefined | InterestProperty
Implementation of VCardDefinition.interest
- Defined in model/classes/VCard.ts:433

key

get key(): undefined | KeyProperty
Returns undefined | KeyProperty
Implementation of VCardDefinition.key
- Defined in model/classes/VCard.ts:403

kind

get kind(): KindProperty<Kind>
Returns KindProperty<Kind>
Implementation of VCardDefinition.kind
- Defined in model/classes/VCard.ts:313

language

get language(): undefined | LanguageProperty
Returns undefined | LanguageProperty
Implementation of VCardDefinition.language
- Defined in model/classes/VCard.ts:352

logo

get logo(): undefined | LogoProperty
Returns undefined | LogoProperty
Implementation of VCardDefinition.logo
- Defined in model/classes/VCard.ts:367

member

get member(): undefined | MemberProperty
Returns undefined | MemberProperty
Implementation of Omit.member
- Defined in model/classes/VCard.ts:415

name

get name(): undefined | NameProperty
Returns undefined | NameProperty
Implementation of VCardDefinition.name
- Defined in model/classes/VCard.ts:322

nickName

get nickName(): undefined | NickNameProperty
Returns undefined | NickNameProperty
Implementation of VCardDefinition.nickName
- Defined in model/classes/VCard.ts:325

note

get note(): undefined | NoteProperty
Returns undefined | NoteProperty
Implementation of VCardDefinition.note
- Defined in model/classes/VCard.ts:379

`Experimental` openId

get openId(): undefined | OpenIdProperty
Experimental
Returns undefined | OpenIdProperty
Implementation of VCardDefinition.openId
- Defined in model/classes/VCard.ts:445

orgDirectory

get orgDirectory(): undefined | OrgDirectoryProperty
Returns undefined | OrgDirectoryProperty
Implementation of VCardDefinition.orgDirectory
- Defined in model/classes/VCard.ts:436

organization

get organization(): undefined | OrganizationProperty
Returns undefined | OrganizationProperty
Implementation of VCardDefinition.organization
- Defined in model/classes/VCard.ts:370

photo

get photo(): undefined | PhotoProperty
Returns undefined | PhotoProperty
Implementation of VCardDefinition.photo
- Defined in model/classes/VCard.ts:328

productId

get productId(): undefined | ProductIdProperty
Returns undefined | ProductIdProperty
Implementation of VCardDefinition.productId
- Defined in model/classes/VCard.ts:382

get related(): undefined | RelatedProperty
Returns undefined | RelatedProperty
Implementation of VCardDefinition.related
- Defined in model/classes/VCard.ts:373

revision

get revision(): undefined | RevisionProperty
Returns undefined | RevisionProperty
Implementation of VCardDefinition.revision
- Defined in model/classes/VCard.ts:385

role

get role(): undefined | RoleProperty
Returns undefined | RoleProperty
Implementation of VCardDefinition.role
- Defined in model/classes/VCard.ts:364

`Experimental` socialCode

get socialCode(): undefined | SocialCodeProperty
Experimental
Returns undefined | SocialCodeProperty
Implementation of VCardDefinition.socialCode
- Defined in model/classes/VCard.ts:454

`Experimental` socialProfile

get socialProfile(): undefined | SocialProfileProperty
Experimental
Returns undefined | SocialProfileProperty
Implementation of VCardDefinition.socialProfile
- Defined in model/classes/VCard.ts:442

sound

get sound(): undefined | SoundProperty
Returns undefined | SoundProperty
Implementation of VCardDefinition.sound
- Defined in model/classes/VCard.ts:388

source

get source(): undefined | SourceProperty
Returns undefined | SourceProperty
Implementation of VCardDefinition.source
- Defined in model/classes/VCard.ts:310

tel

get tel(): undefined | TelProperty
Returns undefined | TelProperty
Implementation of VCardDefinition.tel
- Defined in model/classes/VCard.ts:343

timezone

get timezone(): undefined | TimezoneProperty
Returns undefined | TimezoneProperty
Implementation of VCardDefinition.timezone
- Defined in model/classes/VCard.ts:355

title

get title(): undefined | TitleProperty
Returns undefined | TitleProperty
Implementation of VCardDefinition.title
- Defined in model/classes/VCard.ts:361

uid

get uid(): undefined | UidProperty
Returns undefined | UidProperty
Implementation of VCardDefinition.uid
- Defined in model/classes/VCard.ts:391

url

get url(): undefined | UrlProperty
Returns undefined | UrlProperty
Implementation of VCardDefinition.url
- Defined in model/classes/VCard.ts:397

version

get version(): undefined | VersionProperty
Returns undefined | VersionProperty
Implementation of VCardDefinition.version
- Defined in model/classes/VCard.ts:400

xml

get xml(): undefined | XmlProperty
Returns undefined | XmlProperty
Implementation of VCardDefinition.xml
- Defined in model/classes/VCard.ts:316

Methods

setABLabel

setABLabel(abLabel: ABLabelProperty, parameters?: ABLabelPropertyParameters): void
Experimental
Set the value of the ABLabel property.
Parameters
- abLabel: ABLabelProperty
  
  the ABLabel property value of the vCard.
- Optional parameters: ABLabelPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:900

setAddress

setAddress(address: AddressProperty, parameters?: AddressPropertyParameters): void
Set the value of the address property.
Parameters
- address: AddressProperty
  
  the address property value of the vCard.
- Optional parameters: AddressPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:569

setAlbum

setAlbum(album: AlbumProperty, parameters?: AlbumPropertyParameters): void
Experimental
Set the value of the album property.
Parameters
- album: AlbumProperty
  
  the album property value of the vCard.
- Optional parameters: AlbumPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:873

setAnniversary

setAnniversary(anniversary: AnniversaryProperty, parameters?: AnniversaryPropertyParameters): void
Set the value of the anniversary property.
Parameters
- anniversary: AnniversaryProperty
  
  the anniversary property value of the vCard.
- Optional parameters: AnniversaryPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:553

setBegin

setBegin(begin: BeginProperty): void
Override the value of the begin property.

Deprecated
using this method has no effect, it is only here for completeness.
Parameters
- begin: BeginProperty
  
  the begin property value of the vCard.
Returns void
- Defined in model/classes/VCard.ts:467

setBirthPlace

setBirthPlace(birthPlace: BirthPlaceProperty, parameters?: BirthPlacePropertyParameters): void
Set the value of the birth place property.
Parameters
- birthPlace: BirthPlaceProperty
  
  the birth place property value of the vCard.
- Optional parameters: BirthPlacePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:790

setBirthday

setBirthday(birthday: BirthdayProperty, parameters?: BirthdayPropertyParameters): void
Set the value of the birthday property.
Parameters
- birthday: BirthdayProperty
  
  the birthday property value of the vCard.
- Optional parameters: BirthdayPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:545

setCalendarAddressUri

setCalendarAddressUri(calendarAddressUri: CalendarAddressUriProperty, parameters?: CalendarAddressUriPropertyParameters): void
Set the value of the calendarAddressUri property.
Parameters
- calendarAddressUri: CalendarAddressUriProperty
  
  the calendarAddressUri property value of the vCard.
- Optional parameters: CalendarAddressUriPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:763

setCalendarUri

setCalendarUri(calendarUri: CalendarUriProperty, parameters?: CalendarUriPropertyParameters): void
Set the value of the calendarUri property.
Parameters
- calendarUri: CalendarUriProperty
  
  the calendarUri property value of the vCard.
- Optional parameters: CalendarUriPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:774

setCategories

setCategories(categories: CategoriesProperty, parameters?: CategoriesPropertyParameters): void
Set the value of the categories property.
Parameters
- categories: CategoriesProperty
  
  the categories property value of the vCard.
- Optional parameters: CategoriesPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:665

setClientPidMap

setClientPidMap(clientPidMap: ClientPidMapProperty, parameters?: ClientPIdMapPropertyParameters): void
Set the value of the clientPidMap property.
Parameters
- clientPidMap: ClientPidMapProperty
  
  the clientPidMap property value of the vCard.
- Optional parameters: ClientPIdMapPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:713
setClientPidMap(clientPidMap: ClientPidMapDictionary | ClientPidMapProperty): void
Parameters
- clientPidMap: ClientPidMapDictionary | ClientPidMapProperty
Returns void
- Defined in model/classes/VCard.ts:714

setContactUri

setContactUri(contactUri: ContactUriProperty, parameters?: ContactUriPropertyParameters): void
Set the value of the contact uri property.
Parameters
- contactUri: ContactUriProperty
  
  the contactUri property value of the vCard.
- Optional parameters: ContactUriPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:846

setDeathDate

setDeathDate(deathDate: DeathDateProperty, parameters?: DeathDatePropertyParameters): void
Set the value of the death date property.
Parameters
- deathDate: DeathDateProperty
  
  the death date property value of the vCard.
- Optional parameters: DeathDatePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:806

setDeathPlace

setDeathPlace(deathPlace: DeathPlaceProperty, parameters?: DeathPlacePropertyParameters): void
Set the value of the death place property.
Parameters
- deathPlace: DeathPlaceProperty
  
  the death place property value of the vCard.
- Optional parameters: DeathPlacePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:798

setDepiction

setDepiction(depiction: DepictionProperty, parameters?: DepictionPropertyParameters): void
Experimental
Set the value of the depiction property.
Parameters
- depiction: DepictionProperty
  
  the depiction property value of the vCard.
- Optional parameters: DepictionPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:882

setEmail

setEmail(email: EmailProperty, parameters?: EmailPropertyParameters): void
Set the value of the email property.
Parameters
- email: EmailProperty
  
  the email property value of the vCard.
- Optional parameters: EmailPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:585

setEnd

setEnd(end: EndProperty): void
Override the value of the end property.

Deprecated
using this method has no effect, it is only here for completeness.
Parameters
- end: EndProperty
  
  the end property value of the vCard.
Returns void
- Defined in model/classes/VCard.ts:476

setExpertise

setExpertise(expertise: ExpertiseProperty, parameters?: ExpertisePropertyParameters): void
Set the value of the expertise property.
Parameters
- expertise: ExpertiseProperty
  
  the expertise property value of the vCard.
- Optional parameters: ExpertisePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:814

setFbUrl

setFbUrl(fbUrl: FbUrlProperty, parameters?: FbUrlPropertyParameters): void
Set the value of the fbUrl property.
Parameters
- fbUrl: FbUrlProperty
  
  the fbUrl property value of the vCard.
- Optional parameters: FbUrlPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:755

setFullName

setFullName(fullName: FullNameProperty, parameters?: FullNamePropertyParameters): void
Set the value of the fullName property.
Parameters
- fullName: FullNameProperty
  
  the fullName property value of the vCard.
- Optional parameters: FullNamePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:513

setGender

setGender(gender: GenderProperty, parameters?: GenderPropertyParameters): void
Set the value of the gender property.
Parameters
- gender: GenderProperty
  
  the gender property value of the vCard.
- Optional parameters: GenderPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:561

setGeoLocation

setGeoLocation(geoLocation: GeoLocationProperty, parameters?: GeoLocationPropertyParameters): void
Set the value of the geoLocation property.
Parameters
- geoLocation: GeoLocationProperty
  
  the geoLocation property value of the vCard.
- Optional parameters: GeoLocationPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:617

setHobby

setHobby(hobby: HobbyProperty, parameters?: HobbyPropertyParameters): void
Set the value of the hobby property.
Parameters
- hobby: HobbyProperty
  
  the hobby property value of the vCard.
- Optional parameters: HobbyPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:822

setImpp

setImpp(impp: ImppProperty, parameters?: ImppPropertyParameters): void
Set the value of the impp property.
Parameters
- impp: ImppProperty
  
  the impp property value of the vCard.
- Optional parameters: ImppPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:593

setInterest

setInterest(interest: InterestProperty, parameters?: InterestPropertyParameters): void
Set the value of the interest property.
Parameters
- interest: InterestProperty
  
  the interest property value of the vCard.
- Optional parameters: InterestPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:830

setKey

setKey(key: KeyProperty, parameters?: KeyPropertyParameters): void
Set the value of the key property.
Parameters
- key: KeyProperty
  
  the key property value of the vCard.
- Optional parameters: KeyPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:747

setKind

setKind(kind: KindProperty<Kind>, parameters?: KindPropertyParameters): void
Set the value of the kind property.
Parameters
- kind: KindProperty<Kind>
  
  the kind property value of the vCard.
- Optional parameters: KindPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:497

setLanguage

setLanguage(language: LanguageProperty, parameters?: LanguagePropertyParameters): void
Set the value of the language property.
Parameters
- language: LanguageProperty
  
  the language property value of the vCard.
- Optional parameters: LanguagePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:601

setLogo

setLogo(logo: LogoProperty, parameters?: LogoPropertyParameters): void
Set the value of the logo property.
Parameters
- logo: LogoProperty
  
  the logo property value of the vCard.
- Optional parameters: LogoPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:641

setMember

setMember(member: MemberProperty, parameters?: MemberPropertyParameters): void
Set the value of the member property.
Parameters
- member: MemberProperty
  
  the member property value of the vCard.
- Optional parameters: MemberPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:782

setName

setName(name: NameProperty, parameters?: NamePropertyParameters): void
Set the value of the name property.
Parameters
- name: NameProperty
  
  the name property value of the vCard.
- Optional parameters: NamePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:521

setNickName

setNickName(nickName: NickNameProperty, parameters?: NickNamePropertyParameters): void
Set the value of the nickName property.
Parameters
- nickName: NickNameProperty
  
  the nickName property value of the vCard.
- Optional parameters: NickNamePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:529

setNote

setNote(note: NoteProperty, parameters?: NotePropertyParameters): void
Set the value of the note property.
Parameters
- note: NoteProperty
  
  the note property value of the vCard.
- Optional parameters: NotePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:673

setOpenId

setOpenId(openId: OpenIdProperty, parameters?: OpenIdPropertyParameters): void
Experimental
Set the value of the open ID property.
Parameters
- openId: OpenIdProperty
  
  the open ID property value of the vCard.
- Optional parameters: OpenIdPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:864

setOrgDirectory

setOrgDirectory(orgDirectory: OrgDirectoryProperty, parameters?: OrgDirectoryPropertyParameters): void
Set the value of the osrgDirectory property.
Parameters
- orgDirectory: OrgDirectoryProperty
  
  the orgDirectory property value of the vCard.
- Optional parameters: OrgDirectoryPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:838

setOrganization

setOrganization(organization: OrganizationProperty, parameters?: OrganizationPropertyParameters): void
Set the value of the organization property.
Parameters
- organization: OrganizationProperty
  
  the organization property value of the vCard.
- Optional parameters: OrganizationPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:649

setPhoto

setPhoto(photo: PhotoProperty, parameters?: PhotoPropertyParameters): void
Set the value of the photo property.
Parameters
- photo: PhotoProperty
  
  the photo property value of the vCard.
- Optional parameters: PhotoPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:537

setProductId

setProductId(productId: ProductIdProperty, parameters?: ProductIdPropertyParameters): void
Set the value of the productId property.
Parameters
- productId: ProductIdProperty
  
  the productId property value of the vCard.
- Optional parameters: ProductIdPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:681

setRelated

setRelated(related: RelatedProperty, parameters?: RelatedPropertyParameters): void
Set the value of the related property.
Parameters
- related: RelatedProperty
  
  the related property value of the vCard.
- Optional parameters: RelatedPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:657

setRevision

setRevision(revision: RevisionProperty, parameters?: RevisionPropertyParameters): void
Set the value of the revision property.
Parameters
- revision: RevisionProperty
  
  the revision property value of the vCard.
- Optional parameters: RevisionPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:689

setRole

setRole(role: RoleProperty, parameters?: RolePropertyParameters): void
Set the value of the role property.
Parameters
- role: RoleProperty
  
  the role property value of the vCard.
- Optional parameters: RolePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:633

setSocialCode

setSocialCode(socialCode: SocialCodeProperty, parameters?: SocialCodePropertyParameters): void
Experimental
Set the value of the social code property.
Parameters
- socialCode: SocialCodeProperty
  
  the social code property value of the vCard.
- Optional parameters: SocialCodePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:891

setSocialProfile

setSocialProfile(socialProfile: SocialProfileProperty, parameters?: SocialProfilePropertyParameters): void
Experimental
Set the value of the social profile property.
Parameters
- socialProfile: SocialProfileProperty
  
  the socialProfile property value of the vCard.
- Optional parameters: SocialProfilePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:855

setSound

setSound(sound: SoundProperty, parameters?: SoundPropertyParameters): void
Set the value of the sound property.
Parameters
- sound: SoundProperty
  
  the sound property value of the vCard.
- Optional parameters: SoundPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:697

setSource

setSource(source: SourceProperty, parameters?: SourcePropertyParameters): void
Set the value of the source property.
Parameters
- source: SourceProperty
  
  the source property value of the vCard.
- Optional parameters: SourcePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:484

setTel

setTel(tel: TelProperty, parameters?: TelPropertyParameters): void
Set the value of the tel property.
Parameters
- tel: TelProperty
  
  the tel property value of the vCard.
- Optional parameters: TelPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:577

setTimezone

setTimezone(timezone: TimezoneProperty, parameters?: TimezonePropertyParameters): void
Set the value of the timezone property.
Parameters
- timezone: TimezoneProperty
  
  the timezone property value of the vCard.
- Optional parameters: TimezonePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:609

setTitle

setTitle(title: TitleProperty, parameters?: TitlePropertyParameters): void
Set the value of the title property.
Parameters
- title: TitleProperty
  
  the title property value of the vCard.
- Optional parameters: TitlePropertyParameters
Returns void
- Defined in model/classes/VCard.ts:625

setUid

setUid(uid: UidProperty, parameters?: UIdPropertyParameters): void
Set the value of the uid property.
Parameters
- uid: UidProperty
  
  the uid property value of the vCard.
- Optional parameters: UIdPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:705

setUrl

setUrl(url: UrlProperty, parameters?: UrlPropertyParameters): void
Set the value of the url property.
Parameters
- url: UrlProperty
  
  the url property value of the vCard.
- Optional parameters: UrlPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:731

setVersion

setVersion(version: VersionProperty): void
Set the value of the version property.
Parameters
- version: VersionProperty
  
  the version property value of the vCard.
Returns void
- Defined in model/classes/VCard.ts:739

setXml

setXml(xml: XmlProperty, parameters?: XmlPropertyParameters): void
Set the value of the xml property.
Parameters
- xml: XmlProperty
  
  the xml property value of the vCard.
- Optional parameters: XmlPropertyParameters
Returns void
- Defined in model/classes/VCard.ts:505

stringify

stringify(): string
Alias
toString

Returns string
- Defined in model/classes/VCard.ts:983

toString

toString(): string
Generates a string representation of the vCard compatible with RFC 6350.

Returns
the generated vCard string.

Returns string
- Defined in model/classes/VCard.ts:976

toVCardObject

toVCardObject(): VCardDefinition | VCardGroupDefinition
Generates a simplified vCard definition as a dictionary object.

Returns
The simplified vCard definition.

Returns VCardDefinition | VCardGroupDefinition
- Defined in model/classes/VCard.ts:909

`Static` `Private` asProperty

asProperty<Prop, Params>(value: Prop, parameters?: Params): Prop
Type Parameters
- Prop extends Property<PropertyValue | RecordedPropertyValue, PropertyParameters> | MultiProperty<PropertyValue | RecordedPropertyValue, PropertyParameters>
- Params extends PropertyParameters
Parameters
- value: Prop
- Optional parameters: Params
Returns Prop
- Defined in model/classes/VCard.ts:261

`Static` fromVCardObject

fromVCardObject(vCardObject: VCardDefinition | VCardGroupDefinition): VCard
Generate a vCard instance from a vCard definition object.

Returns
a new VCard instance.
Parameters
- vCardObject: VCardDefinition | VCardGroupDefinition
  
  a vCard Definition in form of an object.
Returns VCard
- Defined in model/classes/VCard.ts:202

Class VCard

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Example

Parameters

kind: KindProperty<Kind> = Kind.Individual

fullName: FullNameProperty = ""

Returns VCard

Properties

Private Optional _abLabel

Private Optional _address

Private Optional _album

Private Optional _anniversary

Private Optional _begin

Private Optional _birthPlace

Private Optional _birthday

Private Optional _calendarAddressUri

Private Optional _calendarUri

Private Optional _categories

Private Optional _clientPidMap

Private Optional _contactUri

Private Optional _deathDate

Private Optional _deathPlace

Private Optional _depiction

Private Optional _email

Private Optional _end

Private Optional _expertise

Private Optional _fbUrl

Private _fullName

Private Optional _gender

Private Optional _geoLocation

Private Optional _hobby

Private Optional _impp

Private Optional _interest

Private Optional _key

Private _kind

Private Optional _language

Private Optional _logo

Private Optional _member

Private Optional _name

Private Optional _nickName

Private Optional _note

Private Optional _openId

Private Optional _orgDirectory

Private Optional _organization

Private Optional _photo

Private Optional _productId

Private Optional _related

Private Optional _revision

Private Optional _role

Private Optional _socialCode

Private Optional _socialProfile

Private Optional _sound

Private Optional _source

Private Optional _tel

Private Optional _timezone

Private Optional _title

Private Optional _uid

Private Optional _url

Private Optional _version

Private Optional _xml

Accessors

Experimental abLabel

Returns undefined | ABLabelProperty

address

Returns undefined | AddressProperty

Experimental album

Returns undefined | AlbumProperty

anniversary

Returns undefined | AnniversaryProperty

begin

Returns undefined | BeginProperty

`Private` `Optional` _abLabel

`Private` `Optional` _address

`Private` `Optional` _album

`Private` `Optional` _anniversary

`Private` `Optional` _begin

`Private` `Optional` _birthPlace

`Private` `Optional` _birthday

`Private` `Optional` _calendarAddressUri

`Private` `Optional` _calendarUri

`Private` `Optional` _categories

`Private` `Optional` _clientPidMap

`Private` `Optional` _contactUri

`Private` `Optional` _deathDate

`Private` `Optional` _deathPlace

`Private` `Optional` _depiction

`Private` `Optional` _email

`Private` `Optional` _end

`Private` `Optional` _expertise

`Private` `Optional` _fbUrl

`Private` _fullName

`Private` `Optional` _gender

`Private` `Optional` _geoLocation

`Private` `Optional` _hobby

`Private` `Optional` _impp

`Private` `Optional` _interest

`Private` `Optional` _key

`Private` _kind

`Private` `Optional` _language

`Private` `Optional` _logo

`Private` `Optional` _member

`Private` `Optional` _name

`Private` `Optional` _nickName

`Private` `Optional` _note

`Private` `Optional` _openId

`Private` `Optional` _orgDirectory

`Private` `Optional` _organization

`Private` `Optional` _photo

`Private` `Optional` _productId

`Private` `Optional` _related

`Private` `Optional` _revision

`Private` `Optional` _role

`Private` `Optional` _socialCode

`Private` `Optional` _socialProfile

`Private` `Optional` _sound

`Private` `Optional` _source

`Private` `Optional` _tel

`Private` `Optional` _timezone

`Private` `Optional` _title

`Private` `Optional` _uid

`Private` `Optional` _url

`Private` `Optional` _version

`Private` `Optional` _xml

`Experimental` abLabel

`Experimental` album

`Experimental` depiction

`Experimental` openId