sbtools (version 1.3.2)

session_renew: Checks current session and re-authenticates if necessary

Description

Checks the state of your Sciencebase session, re-authenticates if the session is expired, and simply renews if the session is active.

Usage

session_renew(password, ..., username)

Value

Returns the session object.

Arguments

password

The password to use, if needed, to renew the session.

...

Any additional parameters are currently ignored.

username

Optional. Used only to confirm that the current username is what you expect; if you want to switch usernames, use authenticate_sb() instead of this function.

Examples

if (FALSE) {
# an empty call is sufficient if the session is current, 
# but will break if haven't been logged in before
session_renew()

# include a password if session may be expired
session_renew('newpass')

# optionally confirm the value of the current username
session_renew(username='[e-mail]', 'newpass')
}