IP*Works! Auth V9 - Online Help
IP*Works! Auth V9
Questions / Feedback?

CookieExpiration Property

This property contains an expiration time for the cookie (if provided by the server).

Syntax

 oauth.getCookieExpiration(index, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCookieExpiration([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCookieExpiration([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0