Class: sesathequeClient

sesathequeClient()

new sesathequeClient()

Fournit des méthodes pour appeler la bibliotheque et récupérer des items normalisés (avec des url absolues)
Initialiser le client avec .getClient puis utiliser dessus les autres méthodes

Source:

Members

(constant) getConfig

Retourne l'objet config (@see ./config.js

Source:

(constant) guessNiveau :function

Retourne le code niveau probable d'après un nom de classe

Type:
  • function
Source:

Methods

addGroupe(baseIdopt, groupeCallback) → {string}

Pour ajouter un groupe, retourne l'url à ouvrir en iframe et appellera groupeCallback
avec le groupe (quand il aura été sauvegardé si le user va au bout)

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
groupeCallback groupeCallback
Source:
Returns:

L'url à ouvrir en iframe

Type
string

addItem(baseIdopt, itemCallback) → {string}

Pour ajouter un item via le form de la sesatheque, retourne l'url à ouvrir en iframe puis appellera itemCallback
avec l'item sauvegardé (quand la ressource aura été sauvegardée si le user va au bout)

Parameters:
Name Type Attributes Description
baseId string <optional>

l'id de la sésathèque
itemCallback itemCallback
Source:
Returns:

L'url à ouvrir en iframe

Type
string

addTokens(authBundles)

Ajoute des tokens d'authentification sur les sésathèques, qui seront envoyés dans le header authorization
(sesalab-sso ne connait que des baseUrl, il met des authBundles en session coté sesalab
et sesalab nous appelle avec s'il y en a)

Parameters:
Name Type Description
authBundles Array.<object>

tableau d'objets {baseUrl:{string}, token:{string}}
Source:

autocomplete(baseId, search, next)

Retourne une liste de filtres de recherche qui matchent le pattern donné

Parameters:
Name Type Description
baseId string

Identifiant de la sésathèque
search string

Pattern de recherche
next searchQueryFiltersCallback

Callback
Source:

cloneItem(baseId, item, next)

Clone un item (créera une ressource sur la sésathèque mentionnée)

Parameters:
Name Type Description
baseId string

L'id de la sésathèque qui aura le clone (l'alias)
item ClientItem

L'item à cloner
next itemCallback
Source:

deleteItem(item, next)

Efface un item

Parameters:
Name Type Description
item ClientItem
next simpleCallback
Source:

getEnfants(item, next)

Retourne les enfants en liste d'items (pas forcément les petits enfants,
il faudra rappeler cette fonction si enfants est une liste vide)

Parameters:
Name Type Description
item ClientItem
next itemsCallback
Source:

getGroupesAdmin(baseIdopt, next)

Récupère la liste des groupes dont on est admin

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
next groupesCallback
Source:

getGroupesMembre(baseIdopt, next)

Récupère la liste des groupes dont on est membre

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
next groupesCallback
Source:

getGroupesSuivis(baseIdopt, next)

Récupère la liste des groupes suivis

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
next groupesCallback
Source:

getGroupesUrl(baseId)

Retourne l'url de gestion des groupes (interface html)

Parameters:
Name Type Description
baseId string
Source:

getItem(rid, isPublicopt, next)

Récupère un item sur une sésathèque

Parameters:
Name Type Attributes Description
rid string

L'identifiant unique de la ressource (baseId/origine/idOrigine également autorisé ici)
isPublic boolean <optional>

passer true pour forcer public (sinon c'est privé si on a un token pour cette sésathèque)
next itemCallback
Source:

getLabel(type) → {string}

Retourne le label pour ce type de ressource

Parameters:
Name Type Description
type string
Source:
Returns:

un nom plus intelligible que le type am|em|…

Type
string

getListeAuteurs(baseId, pids, optionsopt, next)

Récupère la liste des ressources publiques des formateurs donnés

Parameters:
Name Type Attributes Description
baseId string

L'id de la sésathèque ajoutée au préalable
pids Array.<string>

Une liste de pid (personneId, format authSourceBaseId/id)
options Object <optional>
Properties
Name Type Attributes Description
skip number <optional>
limit number <optional>
next itemsByAuteurCallback

appelé avec (error, itemList)
Source:

getListeGroupe(baseIdopt, groupItem, optionsopt, next)

Récupère la liste des ressources d'un groupe

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
groupItem GroupItem | string

Le groupe dont on veut les ressources (ou son nom)
options Object <optional>
Properties
Name Type Attributes Description
skip number <optional>
limit number <optional>
next itemsCallback
Source:

getListePerso(baseId, optionsopt, next)

Récupère la liste des ressources perso du user courant

Parameters:
Name Type Attributes Description
baseId string

L'id de la sésathèque ajoutée au préalable
options Object <optional>
Properties
Name Type Attributes Description
skip number <optional>
limit number <optional>
next itemsCallback

appelé avec (error, itemList)
Source:

getRessource(rid, next)

Récupère une ressource complète sur une sésathèque

Parameters:
Name Type Description
rid string

L'identifiant unique de la ressource (baseId/origine/idOrigine également autorisé ici)
next ressourceCallback
Source:

getSmartSearchUrl(baseId)

Retourne l'url d'accès au formulaire de recherche avancé'

Parameters:
Name Type Description
baseId string
Source:

getUrl(baseId, path, optionsopt) → {string}

Retourne l'url absolue, avec skip et limit si besoin

Parameters:
Name Type Attributes Description
baseId string
path string

le chemin, sans slash de début ni le ? de la queryString
options Object <optional>
Properties
Name Type Attributes Description
skip number <optional>
limit number <optional>
Source:
Returns:

L'url absolue, avec le ? de la queryString (même si y'en a pas)

Type
string

groupCreate(baseIdopt, groupName, next)

Crée un nouveau groupe

Parameters:
Name Type Attributes Description
baseId string <optional>

L'id de la sésathèque
groupName string

Le nom du groupe
next feedbackCallback
Source:

groupIgnore(baseIdopt, group, next)

Stoppe le suivi d'un groupe (on en sera plus follower)

Parameters:
Name Type Attributes Description
baseId string <optional>
group GroupItem
next feedbackCallback
Source:

groupQuit(baseIdopt, group, next)

Quitte un groupe (on en sera plus membre ni follower)

Parameters:
Name Type Attributes Description
baseId string <optional>
group GroupItem
next feedbackCallback
Source:

guessNiveau(classe, forceDegreopt) → {string}

Retourne le code niveau probable d'après un nom de classe

Parameters:
Name Type Attributes Description
classe string
forceDegre string <optional>

passer primaire ou secondaire pour ne tester que ces niveaux (utile de forcer primaire pour éviter que du "tps" ne se retrouve en terminale)
Source:
Returns:

Le code du niveau, undefined si on a rien deviné

Type
string

isDeletable(type) → {boolean}

Retourne true si la ressource peut être effacée (l'originale,
un alias peut toujours être effacé par son proprio)

Parameters:
Name Type Description
type string
Source:
Returns:
Type
boolean

isEditable(type) → {boolean}

Retourne true si la ressource peut être modifiée (i.e. un éditeur existe)

Parameters:
Name Type Description
type string
Source:
Returns:
Type
boolean

modifyItem(item, itemCallback, urlCallback)

Pour modifier un item, retourne d'abord une url à ouvrir en iframe à urlCallback
puis un item sauvegardé à itemCallback (quand la ressource aura été sauvegardée si le user va au bout)

Parameters:
Name Type Description
item ClientItem
itemCallback itemCallback
urlCallback urlCallback
Source:

normalize(ressource) → {ClientItem}

Retourne un item de sesatheque normalisé

Parameters:
Name Type Description
ressource Ref | Ressource
Source:
Returns:

Toujours un ClientItem, éventuellement un fake {type:error, titre: errorMessage} en cas de pb

Type
ClientItem

notifyError(baseId, message, obj)

Notifie une erreur à une sésathèque, à utiliser pour les pbs de datas
garder bugsnag pour les erreurs imprévues du code

Parameters:
Name Type Description
baseId
message
obj
Source:

saveSequenceModele(baseId, sequenceModele, next)

Exporte une séquence modèle d'un sesalab comme ressource sur une sesatheque

Parameters:
Name Type Description
baseId string
sequenceModele object

un objet sequence de sesalab, il doit avoir nom et oid, éventuellement des groupes et une propriété public (booléen à true si "tout le monde" est coché pour le partage)
next itemCallback

sera rappelé avec une erreur ou un item valide
Source:

saveSerie(baseIdopt, data, next)

Exporte une série d'un sesalab comme ressource sur une sesatheque

Parameters:
Name Type Attributes Description
baseId <optional>

L'id de la Sésathèque
data Object

(la propriété parametres doit avoir une propriété serie)
next itemCallback

sera rappelé avec une erreur ou un item valide
Source:

Récupère des résultats de recherche

Parameters:
Name Type Description
baseId string

Identifiant de la sésathèque
searchQueryFilters searchQueryFilters

Object contenant les paramètres de recherche au format {indexName: [...valeurs]}
next function

Callback
Source:

setTimeout(sTimeout)

Modifie le timeout des prochains appels

Parameters:
Name Type Description
sTimeout number

Nouveau timeout en secondes
Source:

Type Definitions

searchQueryFilters

Un objet dont les clés sont des propriétés de ressource et chaque valeur un array avec les valeurs à filtrer pour cette propriété
Par ex {categories: [1, 2], niveaux: ['6']}

Type:
  • Object
Source:

searchQueryFiltersCallback(erroropt, searchQueryFilters)

Parameters:
Name Type Attributes Description
error Error <optional>
searchQueryFilters searchQueryFilters
Source: