annotate framework/env/request/set_perm_param.lua @ 213:d69106e271fc
Renamed "key" argument to "name" argument in request.set_perm_param(...)
 | author | jbe | 
 | date | Sat Jan 10 10:30:01 2015 +0100 (2015-01-10) | 
 | parents | 9fdfb27f8e67 | 
 | children | c3d539e33710 | 
 
 | rev | line source | 
| jbe/bsw@0 | 1 --[[-- | 
| jbe/bsw@0 | 2 request.set_perm_param( | 
| jbe@213 | 3   name,                  -- name of parameter | 
| jbe/bsw@0 | 4   value                  -- value of parameter | 
| jbe/bsw@0 | 5 ) | 
| jbe/bsw@0 | 6 | 
| jbe/bsw@0 | 7 Setting a so-called "permanent parameter" with this function will cause a key value pair to be included in every HTTP link inside the application. It is used as a cookie replacement, where cookies are not suitable, e.g. because you want multiple browser windows to not interfere with each other. | 
| jbe/bsw@0 | 8 | 
| jbe/bsw@0 | 9 --]]-- | 
| jbe/bsw@0 | 10 | 
| jbe@213 | 11 function request.set_perm_param(name, value) | 
| jbe@213 | 12   request._perm_params[name] = value | 
| jbe/bsw@0 | 13 end |