2016-06-11 21:29:34 +02:00
|
|
|
# login
|
|
|
|
|
|
2016-06-11 23:16:01 +02:00
|
|
|
**Namespace** : alphayax\freebox\api\v3\services\login
|
|
|
|
|
|
|
|
|
|
# Overview
|
|
|
|
|
|
|
|
|
|
- [Session](login.md#Session)
|
2016-06-25 14:28:08 +02:00
|
|
|
- [Authorize](login.md#Authorize)
|
2016-06-11 21:29:34 +02:00
|
|
|
|
2016-06-11 23:16:01 +02:00
|
|
|
|
2016-06-25 14:28:08 +02:00
|
|
|
<a name="Session"></a>
|
|
|
|
|
## Session
|
2016-06-11 21:29:34 +02:00
|
|
|
|
2016-06-25 14:28:08 +02:00
|
|
|
**Class** : alphayax\freebox\api\v3\services\login\Session
|
2016-06-11 21:29:34 +02:00
|
|
|
|
|
|
|
|
### Public methods
|
|
|
|
|
|
|
|
|
|
| Method | Description |
|
|
|
|
|
|---|---|
|
2016-06-25 14:28:08 +02:00
|
|
|
| `askLoginStatus` | |
|
|
|
|
|
| `createSession` | |
|
|
|
|
|
| `getSessionToken` | |
|
|
|
|
|
| `getPermissions` | |
|
2016-06-11 21:29:34 +02:00
|
|
|
|
2016-06-25 14:28:08 +02:00
|
|
|
<a name="Authorize"></a>
|
|
|
|
|
## Authorize
|
2016-06-11 21:29:34 +02:00
|
|
|
|
2016-06-25 14:28:08 +02:00
|
|
|
**Class** : alphayax\freebox\api\v3\services\login\Authorize
|
2016-06-11 21:29:34 +02:00
|
|
|
|
|
|
|
|
### Public methods
|
|
|
|
|
|
|
|
|
|
| Method | Description |
|
|
|
|
|
|---|---|
|
2016-06-25 14:28:08 +02:00
|
|
|
| `askAuthorization` | Contact the freebox and ask for App auth |
|
|
|
|
|
| `getAuthorizationStatus` | |
|
|
|
|
|
| `getStatus` | |
|
|
|
|
|
| `getAppToken` | |
|
