Extends

• MelObject

Members

package _listener :MelEventManager

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 106

Overrides:

• MelObject#_listener

package rc_data :Object

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 112

Overrides:

• MelObject#rc_data

Methods

add_event_listener(key, callback, param2)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 835

Ajoute un écouteur qui pourra être appelé plus tard.

Parameters:

Name	Type	Description
key	string	Clé qui permettra d'appeller l'écouteur
callback	function	Fonction qui sera appelée
param2	Object	Si on doit récupérer rcmail sur frame principale ou non Properties Name Type Attributes Description callback_key string <nullable> Clé du callback condition boolean Si on doit éxécuter ou non le listener

Overrides:

• MelObject#add_event_listener

async change_frame(frame, param1) → {Promise:.<void:>}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 915

Change de page

Parameters:

Name	Type	Description
frame	string	Nom de la page
param1	Object	Properties Name Type Attributes Description action string <nullable> Action de la page params Object:.<string:, string:> Paramètres additionnels de la page update boolean {@deprecated} force_update boolean {@deprecated}

Returns:

Promise:.<void:>

Overrides:

• MelObject#change_frame

Deprecated:

• Utilisez plutôt switch_frame

cookie_get(key) → {module:Cookies.Cookie}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1208

Récupère un cookie

Parameters:

Name	Type	Description
key	string	Indentifiant de la donnée

Returns:

module:Cookies.Cookie

Overrides:

• MelObject#cookie_get

cookie_remove(key) → {module:Cookies.Cookie}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1219

Supprime un cookie

Parameters:

Name	Type	Description
key	string	Indentifiant du cookie à supprimer

Returns:

module:Cookies.Cookie - Cookie supprimer

Overrides:

• MelObject#cookie_remove

cookie_set(key, name, expire) → {module:Cookies.Cookie}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1197

Insert un cookie

Parameters:

Name	Type	Default	Description
key	string		Clé qui permet d'identifier la données mise en cookie
name	string		Donnée à mettre en cookie
expire	Date | false	false	Date d'expiration, false pour aucune

Returns:

module:Cookies.Cookie - Cookie créer

Overrides:

• MelObject#cookie_set

copy_to_clipboard(elementToCopy, optionsopt) → {EmptyMelObject}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1184

Copie un texte dans le press(papier)

Parameters:

Name	Type	Attributes	Default	Description
elementToCopy	string			Texte à mettre dans le presse papier
options	Object	<optional>	{}	Properties Name Type Attributes Default Description text string <optional> <nullable> null Texte à afficher lorsque la copie a été effectuée

Returns:

EmptyMelObject - Chaînage

Overrides:

• MelObject#copy_to_clipboard

async create_promise(callback, …args) → {Mel_Promise}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1269

(async) Créer une promesse "Mel" qui contient des fonctionnalités en plus

Parameters:

Name	Type	Attributes	Description
callback
args	any	<repeatable>	Arguments du callback

Returns:

Mel_Promise

Overrides:

• MelObject#create_promise

generate_loader(id, absoluteCenterednon-null) → {mel_html}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1161

Génère un loader du bnum

Parameters:

Name	Type	Default	Description
id	string		id du loader
absoluteCentered	boolean	true	Centrer verticalement et horizontalement ?

Returns:

mel_html

Overrides:

• MelObject#generate_loader

get_custom_rules() → {Mel_CSS_Style_Sheet}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1150

Récupère un objet Mel_CSS_Style_Sheet pour ajouter du css custom

Returns:

Mel_CSS_Style_Sheet

Overrides:

• MelObject#get_custom_rules

get_env(key) → nullable {any}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 898

Récupère une variable d'environnement de roundcube

Parameters:

Name	Type	Description
key	string	Nom de la variable

Returns:

any

Overrides:

• MelObject#get_env

get_skin() → {Mel_Elastic}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1141

Récupère l'objet UI de la skin elastic

Returns:

Mel_Elastic

Overrides:

• MelObject#get_skin

gettext(key_text, pluginnon-null) → {string}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 822

Récupère une clé sous forme de texte.

Parameters:

Name	Type	Description
key_text	string	Clé
plugin	string	Plugin d'où provient le texte traduit

Returns:

string

Overrides:

• MelObject#gettext

have_frame(frame) → {boolean}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 946

Vérifie si une frame est déjà chargée ou non

Parameters:

Name	Type	Description
frame	string	Nom de la frame

Returns:

boolean

Overrides:

• MelObject#have_frame

http_call(options) → {Mel_Ajax}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 999

Effectue un appel ajax avec les options spécifiées.

Parameters:

Name	Type	Description
options	Object	Les options pour l'appel HTTP. Properties Name Type Attributes Default Description url string L'URL à appeler. on_success function <optional> () => {} La fonction à appeler en cas de succès. on_error function <optional> (...args) => {console.error('###[http_call]', ...args)} La fonction à appeler en cas d'erreur. params Object <optional> null Les paramètres à envoyer dans la requête. type string <optional> 'POST' Le type de requête HTTP à effectuer.

Returns:

Mel_Ajax

Overrides:

• MelObject#http_call

http_internal_call(options) → {Mel_Ajax}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1023

Effectue un appel ajax vers les serveurs de l'application

Parameters:

Name	Type	Description
options	Object	Les options pour l'appel HTTP. Properties Name Type Attributes Default Description task string Tache action string Action on_success function <optional> () => {} La fonction à appeler en cas de succès. on_error function <optional> (...args) => {console.error('###[http_call]', ...args)} La fonction à appeler en cas d'erreur. params Object <optional> null Les paramètres à envoyer dans la requête. type string <optional> 'POST' Le type de requête HTTP à effectuer.

Returns:

Mel_Ajax

Overrides:

• MelObject#http_internal_call

http_internal_get(options) → {Mel_Ajax}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1083

Effectue un appel ajax GET vers les serveurs de l'application

Parameters:

Name	Type	Description
options	Object	Les options pour l'appel HTTP. Properties Name Type Attributes Default Description task string Tache action string Action on_success function <optional> () => {} La fonction à appeler en cas de succès. on_error function <optional> (...args) => {console.error('###[http_call]', ...args)} La fonction à appeler en cas d'erreur. params Object <optional> null Les paramètres à envoyer dans la requête.

Returns:

Mel_Ajax

Overrides:

• MelObject#http_internal_get

http_internal_post(options) → {Mel_Ajax}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1054

Effectue un appel ajax POST vers les serveurs de l'application

Parameters:

Name	Type	Description
options	Object	Les options pour l'appel HTTP. Properties Name Type Attributes Default Description task string Tache action string Action on_success function <optional> () => {} La fonction à appeler en cas de succès. on_error function <optional> (...args) => {console.error('###[http_call]', ...args)} La fonction à appeler en cas d'erreur. params Object <optional> null Les paramètres à envoyer dans la requête.

Returns:

Mel_Ajax

Overrides:

• MelObject#http_internal_post

isNullOrUndefined(itemnullable) → {boolean}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1229

Renvoie vrai si la variable vaut `null` ou `undefined`.

Parameters:

Name	Type	Attributes	Description
item	any	<nullable>	Variable à tester

Returns:

boolean

Overrides:

• MelObject#isNullOrUndefined

load(key, default_valuenullable) → nullable {any}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1119

Charge des données dans le stockage local

Parameters:

Name	Type	Attributes	Default	Description
key	string			Clé qui permet de retrouver les données
default_value	any	<nullable>	null	Valeur par défaut si la donnée n'éxiste pas

Returns:

any

Overrides:

• MelObject#load

abstract main(…args)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 152

Parameters:

Name	Type	Attributes	Description
args	any	<repeatable>	Arguments de la fonction

Overrides:

• MelObject#main

on_frame_loaded(callback, options)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 862

Action à faire lorsqu'une frame est chargée

Parameters:

Name	Type	Description
callback	function	Function à éffectuer
options	Object	Options de la fonction Properties Name Type Attributes Description frame string <nullable> any pour toute n'importe quelle frame, sinon mettre le nom de la frame condition function <nullable> Condition custom pour charger la frame

Overrides:

• MelObject#on_frame_loaded

on_frame_refresh(callback, frame, param2)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 888

Ajoute une action à faire lorsqu'une frame est mise à jours

Parameters:

Name	Type	Attributes	Description
callback	function		Callback a=à appelé au refresh
frame	string		Nom de la frame
param2	Object
options.callback_key	string	<nullable>	clé qui permet de supprimer/remettre la fonction au refresh d'une frame

Overrides:

• MelObject#on_frame_refresh

on_refresh(callback, options)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 876

Ajoute une action à faire lors du refresh du bnum

Parameters:

Name	Type	Description
callback	function	Fonction à appeller
options	Object	Options de la fonction Properties Name Type Attributes Description callback_key string <nullable> clé qui permet de supprimer/remettre la fonction au refresh d'une frame

Overrides:

• MelObject#on_refresh

rcmail(top) → {rcube_webmail}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 811

Récupère "rcmail" | les fonctions utiles à roundcube

Parameters:

Name	Type	Default	Description
top	boolean	false	Si on doit récupérer rcmail sur frame principale ou non

Returns:

rcube_webmail

Overrides:

• MelObject#rcmail

save(key, contents) → {MelObject}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1108

Sauvegarde des données dans le stockage local

Parameters:

Name	Type	Description
key	string	Clé qui permettra de retrouver les données sauvegarder
contents	*	Données qui seront sauvegarder

Returns:

MelObject - Chaînage

Overrides:

• MelObject#save

select(selector) → {external:jQuery}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1171

Séléctionne un document dom au format jquery

Parameters:

Name	Type	Description
selector	string	Selecteur au format jquery

Returns:

external:jQuery

Overrides:

• MelObject#select

select_frame(frame) → {external:jQuery}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 956

Selectionne une frame

Parameters:

Name	Type	Description
frame	string	Nom de la frame

Returns:

external:jQuery

Overrides:

• MelObject#select_frame

generator select_frame_except(…frames) → {Generator:.<Node:>}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 968

Selectionne toutes les frames qui ne sont pas parmis les frames définie en arguments

Parameters:

Name	Type	Attributes	Description
frames	string	<repeatable>	Frames à écarter

Returns:

Generator:.<Node:>

Overrides:

• MelObject#select_frame_except

send_notification(notification)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1238

Envoie une notification BNUM

Parameters:

Name	Type	Description
notification	*

Overrides:

• MelObject#send_notification

async sleep(ms) → {Mel_Promise}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1291

(async) Attend x millisecondes

Parameters:

Name	Type	Description
ms	number	Temps en millisecondes

Returns:

Mel_Promise

Overrides:

• MelObject#sleep

async switch_frame(task, options) → {Promise}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 936

Change de frame

Parameters:

Name	Type	Description
task	string	Nom de la tâche
options	Object	Properties Name Type Attributes Default Description changepage boolean <optional> true Si l'on change de page ou si la frame reste caché pendant le chargement. args Object:.<string:, *:> <optional> <nullable> null Options du changement de frame. Si la frame est déjà ouverte, force le changement d'url.

Returns:

Promise

Overrides:

• MelObject#switch_frame

trigger_event(key, args) → {MelEventManager}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 850

Trigger un écouteur

Parameters:

Name	Type	Description
key	string	Clé qui appelera tout les écouteurs lié à cette clé
args	any	Arguments qui sera donnée aux écouteurs

Returns:

MelEventManager

Overrides:

• MelObject#trigger_event

unload(key)

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1132

Décharge une donnée dans le stockage local

Parameters:

Name	Type	Description
key	string	clé dans le stockage

Overrides:

• MelObject#unload

url(task, param1, Autresnullable) → {string}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 981

Récupère une url à partir d'une tâche et d'une action

Parameters:

Name	Type	Attributes	Description
task	string		Nom de la tâche
param1	Object		action => Nom de l'action ('index' si non renseigné), params => Autres paramètres Properties Name Type Description action string => Nom de l'action (index si non renseigné)
Autres	Object:.<string:, string:>	<nullable>	paramètres

Returns:

string

Overrides:

• MelObject#url

async wait_something(callback, optionsopt) → {WaitSomething|WaitSomethingAsync}

Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/mel_object.js, line 1281

(async) Attend qu'une condtion soit valide

Parameters:

Name	Type	Attributes	Default	Description
callback
options	Object	<optional>	{}	Properties Name Type Attributes Default Description timeout number <optional> 5 Au bout de combien de secondes la boucle s'arrête

Returns:

WaitSomething | WaitSomethingAsync

Overrides:

• MelObject#wait_something