UserSession-class: S4 Cytobank UserSession Class

In CytobankAPI: Cytobank API Wrapper for R

S4 Cytobank UserSession Class

Description

A Cytobank UserSession object that holds pertinent user information, used to make calls to various Cytobank endpoints. This class should never be called explicitly. If a user would like to create a new Cytobank UserSession object, utilize the authenticate function.

Value

A Cytobank UserSession object

Slots

auth_token

character representing Cytobank user's authentication token (expires in 8 hours)

long_timeout

numeric representing long request timeout times

short_timeout

numeric representing short request timeout times

site

character representing Cytobank user's site

user_id

integer representing a Cytobank user's ID

Examples

cytobank_user <- new("UserSession", auth_token="my_auth_token", site="premium")

CytobankAPI documentation built on April 21, 2023, 9:08 a.m.