freebox_api_php/docs/services/Call/Contact/Contact.md

93 lines
2.7 KiB
Markdown
Raw Normal View History

2016-06-11 21:29:34 +02:00
# Contact
2016-06-11 23:16:01 +02:00
**Namespace** : alphayax\freebox\api\v3\services\Call\Contact
# Overview
2016-06-25 14:28:08 +02:00
- [ContactNumber](Contact.md#ContactNumber)
2016-06-11 23:16:01 +02:00
- [ContactAddress](Contact.md#ContactAddress)
2016-06-25 14:28:08 +02:00
- [ContactUrl](Contact.md#ContactUrl)
2016-06-11 23:16:01 +02:00
- [ContactEmail](Contact.md#ContactEmail)
- [ContactEntry](Contact.md#ContactEntry)
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
<a name="ContactNumber"></a>
## ContactNumber
**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactNumber
### Public methods
| Method | Description |
|---|---|
| `getFromId` | Get the contact number (with the given id) |
| `create` | Add a new contact number |
| `delete` | Remove a contact number |
| `deleteFromId` | Remove a contact number (with the specified id) |
| `update` | Update a contact number |
2016-06-11 23:16:01 +02:00
<a name="ContactAddress"></a>
2016-06-11 21:29:34 +02:00
## ContactAddress
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactAddress
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getFromId` | Get the address (with the given id) |
| `create` | Add an address |
| `delete` | Remove an address |
| `deleteFromId` | Remove an address (with the given id) |
| `update` | Update an address |
2016-06-25 14:28:08 +02:00
<a name="ContactUrl"></a>
## ContactUrl
**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactUrl
### Public methods
| Method | Description |
|---|---|
| `getFromId` | Get the contact url (with the given id) |
| `create` | Add a new contact url |
| `delete` | Remove a contact url |
| `deleteFromId` | Remove a contact url (with the given id) |
| `update` | Update a contact url |
2016-06-11 23:16:01 +02:00
<a name="ContactEmail"></a>
2016-06-11 21:29:34 +02:00
## ContactEmail
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactEmail
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getFromId` | Get the email contact (with the given id) |
| `create` | Create a new email contact |
| `delete` | Remove an email contact |
| `deleteFromId` | Remove an email contact (with the given id) |
| `update` | Update an email contact |
2016-06-11 23:16:01 +02:00
<a name="ContactEntry"></a>
2016-06-11 21:29:34 +02:00
## ContactEntry
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactEntry
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getAll` | List all contacts |
| `getFromId` | Get a specific contact entry |
| `create` | Add a contact entry |
| `update` | Update a contact entry |
| `delete` | Remove a contact entry |
2016-06-11 23:16:01 +02:00
| `deleteFromId` | Remove a contact entry (with the specified id) |
2016-06-11 21:29:34 +02:00
| `getContactNumbersFromContactId` | Get all numbers associated to a given contact id |
| `getContactAddressesFromContactId` | Get all addresses associated to a given contact id |
| `getContactEmailsFromContactId` | Get all email addresses associated to a given contact id |
| `getContactUrlsFromContactId` | Get all URLs associated to a given contact id |