Skip to content

Latest commit

 

History

History
207 lines (180 loc) · 3.79 KB

DOCUMENTATION.md

File metadata and controls

207 lines (180 loc) · 3.79 KB

logo

Documentation

Autologin

SESSION:

# The Session object allows you to persist certain
# parameters across requests. It also persists
# cookies across all requests made from the session
# instance.

# Create an access to your account with the autologin
# link, given in parameter
create(link):

Example:

access_key = session.create("<AUTOLOGIN LINK>")

USER:

# Init the class to store the elements
# REQUIRED BEFORE LOAD AND SEARCH
init():
# Load the elements inside the class and store
# the user session elements inside, and update them
# REQUIRED BEFORE SEARCH
load(session):
# Search is searching into the datas, the item searched
# and return it, if it doesn't exists it will return 'None'
# REQUIRED THE INIT AND THE LOAD BEFORE
# Type: item's type
search(item):
# data is the complete data list
# Type: LIST
data
# len is the len of the data
# Type: INT
len()

Example:

user = user.init()
user.load(access_key)
user.search('promo')
user.len()
user.data

LOGIN:

# Init the class to store the elements
# REQUIRED BEFORE LOAD AND SEARCH
init():
# Load the elements inside the class and store
# the login session elements inside, and update them
# REQUIRED BEFORE SEARCH
load(session):
# Search is searching into the datas, the item searched
# and return it, if it doesn't exists it will return 'None'
# REQUIRED THE INIT AND THE LOAD BEFORE
# Type: item's type
search(item):
# data is the complete data list
# Type: LIST
data
# len is the len of the data
# Type: INT
len()

Example:

login = login.init()
login.load(access_key)
login.search('message')
login.len()
login.data

NOTIF:

# Init the class to store the elements
# REQUIRED BEFORE LOAD AND SEARCH
init():
# Load the elements inside the class and store
# the notifs session elements inside, and update them
# REQUIRED BEFORE SEARCH
load(session):
# Search is searching into the datas, the item searched
# and return it, if it doesn't exists it will return 'None'
# REQUIRED THE INIT AND THE LOAD BEFORE
# Group must be a int !
# Type: STR
search(group):
# data is the complete data list
# Type: LIST
data
# len is the len of the data
# Type: INT
len()

Example:

notif = notif.init()
notif.load(key)
notif.search(0)
notif.len()
notif.data

User's data:

VALUE TYPE
login str
title str
internal_email str
lastname str
firstname str
userinfo list
referent_used bool
picture str
picture_fun str
scolaryear str
promo int
semester int
location str
documents str
userdocs str
shell str
close bool
ctime str
mtime str
id_promo str
id_history str
course_code str
semester_code str
school_id str
school_code str
school_title str
old_id_promo str
old_id_location str
rights list
invited bool
studentyear int
admin bool
editable bool
restrictprofiles bool

Login's data:

VALUE TYPE
login str
message str
access_token str

Notif's data:

# INT MAX size