---
title: Phone
slug: oip-next/cjwtjjgj2e3idqqxg82ni
createdAt: 2024-02-21T13:29:45.000Z
---

# Phone

## Description

L'entité Phone contient les différentes informations sur la structure d’un numéro de téléphone ainsi que sur son type.

## Relations

### Ascendantes

| Entité       | Propriété |
| ------------ | --------- |
| ActivePolicy | phones    |
| Company      | phones    |
| Contact      | phones    |
| Customer     | phones    |
| Employee     | phones    |
| Grantee      | phones    |
| Tns          | phones    |
| User         | phones    |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| History | history   |

## Liste des propriétés

| Nom               | Type            | Dernière version modifiée | Description                                                            | Getter                    | Setter                    | Deprecated |
| ----------------- | --------------- | ------------------------- | ---------------------------------------------------------------------- | ------------------------- | ------------------------- | ---------- |
| createdAt         | `Date`          |                           | Date de création de l'entité `Phone`                                   | getPhoneCreatedAt         | Lecture seule             | -          |
| createdBy         | `String`        |                           | Utilisateur à l'origine de la création de l'entité `Phone`             | getPhoneCreatedBy         | Lecture seule             | -          |
| id                | `String`        |                           | Identifiant unique de l'entité `Phone`                                 | getPhoneId                | Lecture seule             | -          |
| internationalCode | `String`        | 2.4.0                     | Indicatif téléphone.                                                   | getPhoneInternationalCode | setPhoneInternationalCode | -          |
| isMobile          | `Boolean`       | 2.4.0                     | Permet de savoir si le numéro est un mobile.                           | getPhoneIsMobile          | setPhoneIsMobile          | -          |
| label             | `String`        | 2.7.0                     | Utile pour nommer et identifier un numéro de téléphone en particulier. | getPhoneLabel             | setPhoneLabel             | -          |
| number            | `String`        | 2.6.1                     | Numéro de téléphone.                                                   | getPhoneNumber            | setPhoneNumber            | -          |
| type              | `typePhoneEnum` | 2.4.0                     | Type de numéro de téléphone.                                           | getPhoneType              | setPhoneType              | -          |
| updatedAt         | `Date`          |                           | Date de modification de l'entité `Phone`                               | getPhoneUpdatedAt         | Lecture seule             | -          |
| updatedBy         | `String`        |                           | Utilisateur à l'origine de la modification de l'entité `Phone`         | getPhoneUpdatedBy         | Lecture seule             | -          |

## Enums

### typePhoneEnum

- `typePhoneEnum.FAX`
- `typePhoneEnum.PERSONAL`
- `typePhoneEnum.PROFESSIONAL`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getActivePolicyId } from '@fasstech/oip-core/entities/activePolicy';
import { getCompanyId } from '@fasstech/oip-core/entities/company';
import { getPhoneInternationalCode, getPhoneIsMobile, getPhoneLabel, getPhoneNumber, getPhoneType, getphoneId, setPhoneInternationalCode, setPhoneIsMobile, setPhoneLabel, setPhoneNumber, setPhoneType } from '@fasstech/oip-core/entities/phone';
import { typePhoneEnum } from '@fasstech/oip-core/entities/phone/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let CompanyEntity = await Entities('Company').create();
  let ActivePolicyEntity = await Entities('ActivePolicy').create();
  const PhoneEntity = await Entities('Phone').create();
  
  setPhoneInternationalCode('internationalCode', PhoneEntity);
  setPhoneIsMobile(false, PhoneEntity);
  setPhoneLabel('label', PhoneEntity);
  setPhoneNumber('number', PhoneEntity);
  setPhoneType(typePhoneEnum.PROFESSIONAL, PhoneEntity);
  
  ActivePolicyEntity = await Entities('Phone').save(ActivePolicyEntity, PhoneEntity);
  CompanyEntity = await Entities('ActivePolicy').save(CompanyEntity, ActivePolicyEntity);
  ProjectEntity = await Entities('Company').save(ProjectEntity, CompanyEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const CompanyEntityToTest = await Entities('Company').get(ProjectEntityToTest, getCompanyId(CompanyEntity));
  const ActivePolicyEntityToTest = await Entities('ActivePolicy').get(CompanyEntityToTest, getActivePolicyId(ActivePolicyEntity));
  const PhoneEntityToTest = await Entities('Phone').get(ActivePolicyEntityToTest, getPhoneId(PhoneEntity));
  
  getPhoneInternationalCode(PhoneEntityToTest); // 'internationalCode'
  getPhoneIsMobile(PhoneEntityToTest); // false
  getPhoneLabel(PhoneEntityToTest); // 'label'
  getPhoneNumber(PhoneEntityToTest); // 'number'
  getPhoneType(PhoneEntityToTest); // typePhoneEnum.PROFESSIONAL
})();
```
