Search.setIndex({docnames:["index","modules","ulaval_notify","ulaval_notify.api"],envversion:53,filenames:["index.rst","modules.rst","ulaval_notify.rst","ulaval_notify.api.rst"],objects:{"":{ulaval_notify:[2,0,0,"-"]},"ulaval_notify.api":{constants:[3,0,0,"-"],login:[3,0,0,"-"],notifications:[3,0,0,"-"],session:[3,0,0,"-"]},"ulaval_notify.api.constants":{API_URL:[3,1,1,""],AUTHENTICATION_PAGE_URL:[3,1,1,""],BASE_URL:[3,1,1,""],COOKIE_REGEX:[3,1,1,""],LOCATION_URL:[3,1,1,""]},"ulaval_notify.api.login":{User:[3,2,1,""],login:[3,4,1,""]},"ulaval_notify.api.login.User":{password:[3,3,1,""],username:[3,3,1,""]},"ulaval_notify.api.notifications":{NotificationManager:[3,2,1,""],create_request:[3,4,1,""],find_appropriate_notification_callback:[3,4,1,""],send_linux_notification:[3,4,1,""]},"ulaval_notify.api.notifications.NotificationManager":{check_notifications:[3,5,1,""],notification_route:[3,3,1,""]},"ulaval_notify.api.session":{SessionManager:[3,2,1,""],Token:[3,2,1,""],UserDetails:[3,2,1,""],create_token:[3,4,1,""],create_user_details:[3,4,1,""],refresh_periodically:[3,4,1,""]},"ulaval_notify.api.session.SessionManager":{refresh:[3,5,1,""],refresh_session_route:[3,3,1,""],refresh_token_route:[3,3,1,""],send:[3,5,1,""],token_details:[3,3,1,""],user_details:[3,3,1,""]},"ulaval_notify.api.session.Token":{client_id:[3,3,1,""],expiration_date:[3,3,1,""],token:[3,3,1,""],token_type:[3,3,1,""]},"ulaval_notify.api.session.UserDetails":{change_number:[3,3,1,""],email:[3,3,1,""],first_name:[3,3,1,""],identification_number:[3,3,1,""],last_name:[3,3,1,""],user_id:[3,3,1,""],username:[3,3,1,""]},"ulaval_notify.constants":{SESSION_REFRESH_INTERVAL_IN_SECONDS:[2,1,1,""]},"ulaval_notify.main":{main:[2,4,1,""]},"ulaval_notify.options":{parse_arguments:[2,4,1,""]},"ulaval_notify.utils":{Decorator:[2,2,1,""],before:[2,2,1,""],dummy_wrap:[2,4,1,""],run_as_daemon:[2,4,1,""]},"ulaval_notify.utils.Decorator":{wraps:[2,5,1,""]},"ulaval_notify.utils.before":{wraps:[2,5,1,""]},ulaval_notify:{api:[3,0,0,"-"],constants:[2,0,0,"-"],main:[2,0,0,"-"],options:[2,0,0,"-"],utils:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:attribute","4":"py:function","5":"py:method"},terms:{"class":[2,3],"gagn\u00e9":[2,3],"return":3,The:[2,3],about:3,alia:3,antoin:[2,3],api_url:3,applic:2,arg:2,argpars:2,argument:2,argumentpars:2,auth:3,authent:3,authentication_page_url:3,authentif:3,base:[2,3],base_url:3,befor:[2,3],callback:3,can:3,change_numb:3,check_notif:3,client_id:3,code:[2,3],command:2,commun:3,constant:1,contain:[2,3],content:1,contexteutilisateur:3,cooki:3,cookie_cont:3,cookie_nam:3,cookie_regex:3,copyright:[2,3],correspond:3,creat:[2,3],create_request:3,create_token:3,create_user_detail:3,credenti:3,current:3,decor:2,delegu:3,detail:[2,3],dummy_wrap:2,elaps:2,email:3,entri:2,everi:3,execut:2,expiration_d:3,field:3,find_appropriate_notification_callback:3,first_nam:3,given:3,handl:3,held:3,hold:3,html:3,http:3,identification_numb:3,idul:3,immut:3,index:0,inform:3,interv:[2,3],kwarg:2,kwrag:2,last_nam:3,licens:[2,3],line:2,location_url:3,log:3,main:1,make:3,manag:3,messagesimport:3,mit:[2,3],modul:[0,1],monportail:3,more:[2,3],mpo:3,name:3,need:3,none:3,notification_rout:3,notificationmanag:3,number:3,oauth:3,object:[2,3],option:1,packag:1,page:[0,3],paramet:3,pars:2,parse_argu:2,password:3,platform_nam:3,point:2,rafraichirtoken:3,refresh:[2,3],refresh_period:3,refresh_session_rout:3,refresh_token_rout:3,refreshsess:3,regex:3,relat:[2,3],request:3,respons:3,rout:3,run_as_daemon:2,search:0,securit:3,see:[2,3],send:3,send_linux_notif:3,servicesecurestorag:3,session:2,session_manag:3,session_refresh_interval_in_second:2,sessionmanag:3,set:3,setitem:3,sourc:[2,3],specifi:3,submodul:1,thi:[2,3],time:[2,3],token:3,token_detail:3,token_typ:3,tupl:3,type:3,ulav:3,url:3,urlretour:3,use:3,used:3,user:3,user_detail:3,user_id:3,userdetail:3,usernam:3,util:1,websit:3,wrap:2},titles:["Welcome to ulaval-notify\u2019s documentation!","ulaval_notify","ulaval_notify package","ulaval_notify.api package"],titleterms:{api:3,constant:[2,3],content:[2,3],document:0,indic:0,login:3,main:2,modul:[2,3],notif:3,notifi:0,option:2,packag:[2,3],session:3,submodul:[2,3],tabl:0,ulav:0,ulaval_notifi:[1,2,3],util:2,welcom:0}})