edge/doc/apps/server-api/app.md

Module app

Ce module permet de récupérer des informations sur les applications actives dans l'environnement Edge courant.

Méthodes

app.list(ctx: Context): []Manifest

Récupère la liste des applications actives.

Arguments

• ctx Context Le contexte d'exécution. Voir la documentation du module context

Valeur de retour

Liste des objets Manifest décrivant chaque application active.

app.get(ctx: Context, appId: string): Manifest

Récupère les informations de l'application identifiée par appId.

Arguments

• ctx Context Le contexte d'exécution. Voir la documentation du module context
• appId string Identifiant de l'application

Valeur de retour

Objet Manifest associé à l'application, ou null si aucune application n'a été trouvée correspondant à l'identifiant.

app.getUrl(ctx: Context, appId: string, from: string = ''): Manifest

Retourne l'URL permettant d'accéder à l'application identifiée par appId.

Arguments

• ctx Context Le contexte d'exécution. Voir la documentation du module context
• appId string Identifiant de l'application
• from string Adresse IP qui accédera à l'application (permet de générer la bonne URL vis à vis du réseau d'origine)

Valeur de retour

URL associée à l'application, ou null si aucune application n'a été trouvée correspondant à l'identifiant.

Objets

Manifest

interface Manifest {
    id: string                          // Identifiant de l'application
    version: string                     // Version de l'application
    title: string                       // Titre associé à l'application
    description: string                 // Description associée à l'application
    tags: string[]                      // Mots clés associés à l'application
    metadata: { [key: string]: any }    // Métadonnées associées à l'application. Voir ../manifest.md
}