Class: Ref

Ref(valuesopt)

new Ref(valuesopt)

Définition d'une référence à une ressource, que l'on peut rencontrer dans les feuilles d'un arbre
Ce n'est pas une entité

Parameters:
Name Type Attributes Default Description
values Object <optional>
{}

L'objet qui sert à initialiser un nouvel objet Ref, accepte une Ressource

Source:
Throws:

Si on passe des enfants sur un type non arbre

Type
Error

Members

aliasOf :string

La ressource référencée (baseId/oid)

Type:
  • string
Source:

aliasRid :string

Rid de la Ressource "alias" qui a servi à construire cette Ref
Utile pour le normalize de sesatheque-client qui construit les urls
(distinguer les urls d'affichage qui pointent vers l'original
et celles de modif qui pointent sur l'alias)

Type:
  • string
Source:

categories :Array.<number>

Un ou des id de catégorie(s) éventuel (pour un picto)

Type:
  • Array.<number>
Source:

cle :string

Éventuelle clé de lecture, pour que des élèves puissent lire
la ressource non publique si leur prof la leur affecte

Type:
  • string
Source:

commentaires :string

Commentaires (pour le formateur)

Type:
  • string
Source:

description :string

Description (pour tous)

Type:
  • string
Source:

enfants :Array.<Ref>

Liste d'enfants

Type:
Source:

inc :number

Un incrément ajouté à l'url pour contourner le cache du navigateur en cas de modif

Type:
  • number
Source:

parametres :Object

Les paramètres pour le type sequenceModele, forcément un plain Object

Type:
  • Object
Source:

partage :boolean

true si la ressource privée est partagée avec un ou des groupes

Type:
  • boolean
Default Value:
  • undefined
Source:

public :boolean

True si public (sinon il faut être authentifié pour lire la ressource)

Type:
  • boolean
Source:

resume :string

Résumé (pour tous)

Type:
  • string
Source:

titre :string

Titre

Type:
  • string
Source:

type :string

Le type qui permet de savoir à quel type de contenu s'attendre, ou quel picto afficher

Type:
  • string
Source:

Methods

toString() → {string}

Cast en string d'une ref (son titre avec aliasOf)

Source:
Returns:
Type
string