qik.session.authorize
This is to authorize session as a user.
Synopsis: qik.session.authorize(session, login, password)
Input:
Param
|
Type
|
Description
|
session
|
str
|
Creates a unique session ID
|
| login |
str |
For user to login |
| password |
str |
For user to enter password |
Return:
Param
|
Type
|
Description
|
int
|
int
|
User ID for authorized user
|
raises QSessionAlreadyAuthorizedError
if session is already authorized
raises QUserAuthorizeError
if login/password don't match account
qik.session.create
This is to create a new session
Synopsis: qik.session.create()
Return:
Type
|
Description
|
| str |
Creates a session ID
|
qik.session.destroy
This is to destroy a session
Synopsis: qik.session.destroy(session)
Input:
Param
|
Type
|
Description
|
session
|
str |
Session ID
|
qik.session.get_events
Get all the events for current session. If there are some events queued, they are returned immediately, otherwise we wait no more than timeout seconds for events to come.
Synopsis: qik.session.get_events(session, timeout=30)
Input:
Param
|
Type
|
Description
|
session
|
str |
Session ID
|
Return:
Type
|
Description
|
| list |
list of events queued so far (if timeouted, then [])
|
qik.session.unsubscribe
Unsubscribe from some subscription. Subscription is identified by its key, subscription_key. Method is asynchronous, no error is ever reported from this method.
Synopsis: qik.session.unsubscribe(session, subscription_key)
Input:
Param
|
Type
|
Description
|
session
|
str |
Session ID
|
| subscription_key |
str |
Subscription Key |
Comments (0)
You don't have permission to comment on this page.