Metody v User

Metody umístěné ve jmenném prostoru User.

Metoda attr

Vrátí hodnotu atributu uživatelského nastavení.

typ: method; celé jméno: COMEX.User.attr;

• Tvořeno souborem: /comex/scripts/comex-page.js

Parametry:

• $attribute ● hodnota typu String název atributu (name, id, ...)

Vrací:

• hodnota typu Stringhodnota atributu

• hodnota typu nullnull, pokud neexistuje

Metoda authorize

Vyvolá autorizaci uživatele, pokud není k dispozici jeho nastavení.

typ: method; celé jméno: COMEX.User.authorize;

• Tvořeno souborem: /comex/scripts/comex-page.js

Vrací:

• hodnota typu Booleantrue, pokud je uživatel autorizovaný, jinak false

Metoda confirm

Zobrazí potvrzovací dialog.

typ: method; celé jméno: COMEX.User.confirm;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $value ● hodnota typu String obsah dialogu

• $handler ● hodnota typu Function handler funkce, která bude zavolána po zavření dialogu

• $timeout ● hodnota typu Integer (výchozí: undefined) počet sekund pro automatické zavření dialogu

• $yesretval ● hodnota typu mixed (výchozí: true) návratová hodnota pro ANO

• $noretval ● hodnota typu mixed (výchozí: false) návratová hodnota pro NE

• $default ● hodnota typu Boolean (výchozí: false) defaultně vybrané tlačítko

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda drop

Zahodí vlastnost uživatele.

typ: method; celé jméno: COMEX.User.drop;

Parametry:

• $property ● hodnota typu String název vlastnosti

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex.js )

Metoda error

Zobrazí chybový dialog.

typ: method; celé jméno: COMEX.User.error;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $value ● hodnota typu String obsah dialogu

• $handler ● hodnota typu Function (výchozí: undefined) handler funkce, která bude zavolána po zavření dialogu

• $timeout ● hodnota typu Integer (výchozí: undefined) počet sekund pro automatické zavření dialogu

• $retval ● hodnota typu mixed (výchozí: true) návratová hodnota

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda execute

Provede uživatelskou akci.

typ: method; celé jméno: COMEX.User.execute;

• Tvořeno souborem: /comex/scripts/comex-page.js

Parametry:

• $action ● hodnota typu String název prováděné akce

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda hasFunction

Vrátí příznak, zda má uživatel požadovanou funkci.

typ: method; celé jméno: COMEX.User.hasFunction;

• Tvořeno souborem: /comex/scripts/comex-page.js

Parametry:

• $function ● hodnota typu String identifikátor funkce

Vrací:

• hodnota typu Booleantrue, pokud má uživatel funkci, jinak false

Metoda hasRole

Vrátí příznak, zda má uživatel požadovanou roli.

typ: method; celé jméno: COMEX.User.hasRole;

• Tvořeno souborem: /comex/scripts/comex-page.js

Parametry:

• $role ● hodnota typu String identifikátor role

Vrací:

• hodnota typu Booleantrue, pokud má uživatel funkci, jinak false

Metoda help

Zobrazí/skryje nápovědu.

Nápověda bude zobrazena na základě vyplnění atributu data-help u daného elementu.

typ: method; celé jméno: COMEX.User.help;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $show ● hodnota typu boolean true, pokud má být nápověda zobrazena, jinak false

• $event ● hodnota typu Event (výchozí: undefined) událost, která vyvolala zobrazení nápovědy

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda hold

Nastaví vlastnost uživatele.

typ: method; celé jméno: COMEX.User.hold;

Parametry:

• $property ● hodnota typu String název vlastnosti

• $value ● hodnota typu mixed hodnota vlastnosti

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex.js )

Metoda changePassword

Změna hesla uživatele.

typ: method; celé jméno: COMEX.User.changePassword;

• Tvořeno souborem: /comex/scripts/comex-page.js

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda info

Zobrazí informativní dialog.

typ: method; celé jméno: COMEX.User.info;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $value ● hodnota typu String obsah dialogu

• $handler ● hodnota typu Function (výchozí: undefined) handler funkce, která bude zavolána po zavření dialogu

• $timeout ● hodnota typu Integer (výchozí: undefined) počet sekund pro automatické zavření dialogu

• $retval ● hodnota typu mixed (výchozí: true) návratová hodnota

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda login

Přihlášení uživatele.

typ: method; celé jméno: COMEX.User.login;

• Tvořeno souborem: /comex/scripts/comex-page.js

Vrací:

• hodnota typu Booleantrue, pokud přihlášení proběhlo v pořádku, jinak false

Metoda logout

Odhlášení uživatele.

typ: method; celé jméno: COMEX.User.logout;

• Tvořeno souborem: /comex/scripts/comex-page.js

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda owns

Vrátí vlastnost uživatele.

typ: method; celé jméno: COMEX.User.owns;

Parametry:

• $property ● hodnota typu String název vlastnosti

Vrací:

• hodnota typu mixedhodnota vlastnosti

( umístěno v souboru /comex/scripts/comex.js )

Metoda select

Zobrazí výběrový dialog.

typ: method; celé jméno: COMEX.User.select;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $title ● hodnota typu String nadpis dialogu

• $options ● hodnota typu COMEX.UI.Controls.Option???[ Integer ] pole definic výběrových voleb/skupin výběrových voleb ● hodnota typu Element[ Integer ] pole elementů option/optgroup elementu select

• $handler ● hodnota typu Function handler funkce, která bude zavolána po zavření dialogu

• $filter ● hodnota typu Boolean (výchozí: false) true, pokud je možné filtrování položek, jinak false

• $hideFirst ● hodnota typu Boolean (výchozí: false) true, pokud má být první volba skrytá, jinak false

• $width ● hodnota typu Integer (výchozí: 480) šířka dialogu v px

Vrací:

• hodnota typu voidbez návratové hodnoty

Metoda solve

Odešle požadavek k vyřízení na server.

typ: method; celé jméno: COMEX.User.solve;

• Tvořeno souborem: /comex/scripts/comex-page.js

Parametry:

• $request ● hodnota typu COMEX.XML.Doc XML dokument požadavku ● hodnota typu String XML data požadavku

• $relogin ● hodnota typu Boolean (výchozí: true) true, pokud se při neúspěšném vyřízení požadavku má vynutit opětovné přihlášení a znovuodeslání poažadvku, jinak false

Vrací:

• hodnota typu COMEX.XML.Docdokument odpovědi

• hodnota typu nullnull, pokud nebylo možné požadavek vyřídit

Metoda warning

Zobrazí varovný dialog.

typ: method; celé jméno: COMEX.User.warning;

• Tvořeno souborem: /comex/scripts/comex-ui.js

Parametry:

• $value ● hodnota typu String obsah dialogu

• $handler ● hodnota typu Function (výchozí: undefined) handler funkce, která bude zavolána po zavření dialogu

• $timeout ● hodnota typu Integer (výchozí: undefined) počet sekund pro automatické zavření dialogu

• $retval ● hodnota typu mixed (výchozí: true) návratová hodnota

Vrací:

• hodnota typu voidbez návratové hodnoty