login: Login to 'PhotosynQ'

Description Usage Arguments Details Value Note Examples

View source: R/login.R

Description

Login to 'PhotosynQ' to allow data access.

Usage

1
login(email = "", url = photosynq.env$DEFAULT_API_DOMAIN)

Arguments

email

Your email address you use to login

url

(optional) Change the default URL to point to another instance

Details

This function allows a user to login to 'PhotosynQ' and start a session. The functions getProjectInfo, getProjectData, getProject and logout require a session started by login in. A login is only required once at the beginning of a session.

Value

Session key is received and session data is stored as a global variable. Otherwise nothing is returned.

Note

The password needs to be entered in a dialog and gets never saved nor should it be saved anywhere in the code.

Examples

1
2
3
4
## Not run: 
login("john.doe@domain.com")

## End(Not run)

Photosynq/PhotosynQ-R documentation built on July 19, 2021, 4:33 a.m.