Class Name

Name API object

Hierarchy (View Summary)

ContactUniqueComponent
- Name

Index

Constructors

Properties

first_name? formatted_name last_name? middle_name? prefix? suffix?

Constructors

constructor

new Name(
    formatted_name: string,
    first_name?: string,
    last_name?: string,
    middle_name?: string,
    suffix?: string,
    prefix?: string,
): Name
Builds a name object for a contact, required for contacts. The object requires a formatted_name and at least another property.
Parameters
- formatted_name: string
  Full name, as it normally appears
- Optionalfirst_name: string
  First name
- Optionallast_name: string
  Last name
- Optionalmiddle_name: string
  Middle name
- Optionalsuffix: string
  Name suffix
- Optionalprefix: string
  Name prefix
Returns Name
Throws
If no other component apart from formatted_name is defined
Overrides ContactUniqueComponent.constructor
- Defined in src/messages/contacts.ts:340

Properties

`Optional` `Readonly`first_name

first_name?: string

The first name of the contact

`Readonly`formatted_name

formatted_name: string

The formatted name of the contact

`Optional` `Readonly`last_name

last_name?: string

The last name of the contact

`Optional` `Readonly`middle_name

middle_name?: string

The middle name of the contact

`Optional` `Readonly`prefix

prefix?: string

The prefix of the contact

`Optional` `Readonly`suffix

suffix?: string

The suffix of the contact