The timeout-uri Element"

From Documentation
(Created page with '{{ZKConfigurationReferencePageHeader}} == The timeout-uri Element == [Optional] [Since 3.6.3] [Default: <i>null</i>] It specifies the target URI that will be used to redirec…')
 
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{ZKConfigurationReferencePageHeader}}
 
{{ZKConfigurationReferencePageHeader}}
  
== The timeout-uri Element ==
+
'''Syntax:'''
 +
<timeout-uri>''a_uri''</timeout-uri>
 +
 
 
  [Optional]
 
  [Optional]
 
  [Since 3.6.3]
 
  [Since 3.6.3]
Line 8: Line 10:
 
It specifies the target URI that will be used to redirect users to, when the desktop no longer exists – it is usually caused by session timeout.
 
It specifies the target URI that will be used to redirect users to, when the desktop no longer exists – it is usually caused by session timeout.
  
If this element is omitted (default), an error message will be shown up at the browser to alert users for what happens. If you want to customize the message, please use the timeout-message element.
+
If this element is omitted (default), an error message will be shown up at the browser to alert users what has happened. If you want to customize the message, please use the timeout-message element.
  
 
To reload the same URI again, you can specify an ''empty'' content as follows.
 
To reload the same URI again, you can specify an ''empty'' content as follows.
Line 19: Line 21:
 
</source>
 
</source>
  
Notice that this setting is applied only to the specified device ([[#The device-type Element|&lt;device-type&gt;]]), so remember to specify the correct device.
+
Notice that this setting is applied only to the specified device (<device-type>), so remember to specify the correct device.
 +
 
 +
For more information, please refer to [[ZK Developer's Reference/UI Patterns/Session Timeout Management]].
  
 
=Version History=
 
=Version History=

Latest revision as of 03:11, 8 August 2011



Syntax:

<timeout-uri>a_uri</timeout-uri>
[Optional]
[Since 3.6.3]
[Default: null]

It specifies the target URI that will be used to redirect users to, when the desktop no longer exists – it is usually caused by session timeout.

If this element is omitted (default), an error message will be shown up at the browser to alert users what has happened. If you want to customize the message, please use the timeout-message element.

To reload the same URI again, you can specify an empty content as follows.

<session-config>
	<device-type>ajax</device-type>
	<timeout-uri></timeout-uri>
</session-config>

Notice that this setting is applied only to the specified device (<device-type>), so remember to specify the correct device.

For more information, please refer to ZK Developer's Reference/UI Patterns/Session Timeout Management.

Version History

Last Update : 2011/08/08


Version Date Content
     



Last Update : 2011/08/08

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.