Méthodes
addListener(type, listener): Promise.<boolean>
Attacher un gestionnaire d'événements.
Paramètres
| Nom | Type | Description |
|---|---|---|
type |
string | Type des événements ('idal-player-event', 'idal-contact-event'...). |
listener |
Listener | Fonction à exécuter lorsqu'un événement survient. |
Valeur de retour
Une promesse résolue avec une valeur de type boolean.
- Type
- Promise.<boolean>
delete(path): Promise.<ApiResponse>
Envoyer une requête DELETE sur l'API HTTP du lecteur video player.
Paramètres
| Nom | Type | Description |
|---|---|---|
path |
string | Le chemin de l'API à exécuter. |
Valeur de retour
Une promesse résolue ou rejetée avec une valeur de type ApiResponse
- Type
- Promise.<ApiResponse>
get(path): Promise.<ApiResponse>
Envoyer une requête GET sur l'API HTTP du lecteur video player.
Paramètres
| Nom | Type | Description |
|---|---|---|
path |
string | Le chemin de l'API à exécuter. |
Valeur de retour
Une promesse résolue ou rejetée avec une valeur de type ApiResponse
- Type
- Promise.<ApiResponse>
post(path, dataopt): Promise.<ApiResponse>
Envoyer une requête POST sur l'API HTTP du lecteur video player.
L'appel peut contenir des données utilisateur qui seront placées dans le champs data de la requête.
Paramètres
| Nom | Type | Attributs | Description |
|---|---|---|---|
path |
string | Chemin de l'API à exécuter. |
|
data |
* |
<optionnel> |
Données à renseigner dans le champs |
Valeur de retour
Une promesse résolue ou rejetée avec une valeur de type ApiResponse
- Type
- Promise.<ApiResponse>
removeListener(type, listener): Promise.<boolean>
Détacher un gestionnaire d'événements.
Paramètres
| Nom | Type | Description |
|---|---|---|
type |
string | Type des événements. |
listener |
Listener | Fonction précédemment attachée avec addListener(). |
Valeur de retour
Une promesse résolue avec une valeur de type boolean.
- Type
- Promise.<boolean>
Définition des types
ApiError
Raison d'une erreur.
Propriétés
| Nom | Type | Description |
|---|---|---|
code |
number | Code d'erreur (statut HTTP). |
appcode |
string | Code d'erreur applicatif. |
message |
string | Message humainement lisible. |
ApiResponse
Réponse à un appel sur l'API HTTP d'un lecteur vidéo.
Propriétés
| Nom | Type | Attributs | Description |
|---|---|---|---|
data |
* |
<optionnel> |
En cas de succès, les données de la réponse. |
errors |
Array.<ApiError> |
<optionnel> |
En cas d'erreur, les raisons de l'erreur. |
Listener(event): void
Fonction de gestion d'événements.
Un Listener peut être passé à IDALClient.addListener() et IDALClient.removeListener() pour gérer les changement d'états des lecteurs video.
Paramètres
| Nom | Type | Description |
|---|---|---|
event |
external:CustomEvent | Événement venant de survenir. |
Valeur de retour
- Type
- void