WTVP/Processes/Favorites: Difference between revisions
(Add initial WTVP favorites page) |
(→Adding favorites: Start writing documentation on favorite add service) |
||
| Line 18: | Line 18: | ||
== Adding favorites == | == Adding favorites == | ||
''' | |||
WebTV and MSN TV have a panel for adding a site as a favorite to a designated favorite folder, which can be opened by selecting the "Save" button from the Options panel. When a user adds a site as a favorite, the client will make a <code>POST</code> request to the service URL <code>wtv-favorite:/add</code>, which sends a query string of the information for the favorite and which folder to put it in, along with an image type for the thumbnail. The thumbnail data is sent in the body. | |||
<pre> | |||
POST wtv-favorite:/add?favorite-category=Favorite+Folder+Name&favorite-title=Website+Title&favorite-thumbnail-type=image/wtv-bitmap&favorite-url=wtv-home%3A%2Fhome\r\n | |||
wtv-system-cpuspeed: 166164662\r\n | |||
wtv-system-sysconfig: 3116068\r\n | |||
wtv-disk-size: 8006\r\n | |||
wtv-incarnation: 32\r\n | |||
Content-type: application/x-www-form-urlencoded\r\n | |||
Content-length: {length of thumbnail data}\r\n | |||
\r\n | |||
</pre> | |||
'''TODO: Write up how favorite service works server-side''' | |||
=== Parameters === | |||
{| class="wikitable" | |||
|- | |||
! Parameter | |||
! Description | |||
|- | |||
| favorite-category | |||
| The name of the favorite folder (category) to add the favorite to | |||
|- | |||
| favorite-name | |||
| The name for the favorite (usually the page title) | |||
|- | |||
| favorite-thumbnail-type | |||
| The file type for the favorite thumbnail to upload for the favorite. Currently, the only known value sent is <code>image/wtv-bitmap</code> | |||
|- | |||
| favorite-url | |||
| URL for the favorite to point to. This can be a service URL or a normal website URL | |||
|} | |||
Latest revision as of 20:49, 10 August 2023
| WTVP |
|---|
| Overview • List of WTVP Services • WTVP-specific Content-Types • Status Codes |
| Concepts |
| Tokens • Tickets • Capability Flags |
| Headers |
| Header List • Data Types • Common Request Headers |
| Processes |
| First-Time Registration • Headwaiter (Login) • Messenger Services • Favorites • Checking for new mail • Retrieving settings • Obtaining new wtv-tickets • Smart Card • Miscellaneous |
| URLs for WTVP Services |
| wtv-1800 • wtv-aroundtown • wtv-author • wtv-center • wtv-chat • wtv-content • wtv-cookie • wtv-customscript • wtv-disk • wtv-epguide • wtv-favorite • wtv-flashrom • wtv-guide • wtv-head-waiter • wtv-home • wtv-intro • wtv-log • wtv-mail • wtv-news • wtv-notices • wtv-partner • wtv-passport • wtv-register • wtv-setup • wtv-smartcard • wtv-spot • wtv-star • wtv-tricks • wtv-tutorial |
Folder list
When a WebTV/MSN TV client has to retrieve the list of favorite folders for the current user, it will make a WTVP GET request to the service URL defined in the wtv-favorites-folders-url header from the final headwaiter response. The service the URL points to is usually hosted on wtv-favorite, and the service URL used by the original service was wtv-favorite:/list-folders.
The response for the folder list service has a Content-Type of text/html, but the body data is a NUL-terminated sequence of strings representing the names of the favorite folders on the current user's account.
200 OK\n
Connection: Keep-Alive\n
wtv-encrypted: true\n
wtv-lzpf: 0\n
Content-length: {length of body}\n
Content-type: text/html\n
\n
Personal[0x00]Recommended[0x00]
Adding favorites
WebTV and MSN TV have a panel for adding a site as a favorite to a designated favorite folder, which can be opened by selecting the "Save" button from the Options panel. When a user adds a site as a favorite, the client will make a POST request to the service URL wtv-favorite:/add, which sends a query string of the information for the favorite and which folder to put it in, along with an image type for the thumbnail. The thumbnail data is sent in the body.
POST wtv-favorite:/add?favorite-category=Favorite+Folder+Name&favorite-title=Website+Title&favorite-thumbnail-type=image/wtv-bitmap&favorite-url=wtv-home%3A%2Fhome\r\n
wtv-system-cpuspeed: 166164662\r\n
wtv-system-sysconfig: 3116068\r\n
wtv-disk-size: 8006\r\n
wtv-incarnation: 32\r\n
Content-type: application/x-www-form-urlencoded\r\n
Content-length: {length of thumbnail data}\r\n
\r\n
TODO: Write up how favorite service works server-side
Parameters
| Parameter | Description |
|---|---|
| favorite-category | The name of the favorite folder (category) to add the favorite to |
| favorite-name | The name for the favorite (usually the page title) |
| favorite-thumbnail-type | The file type for the favorite thumbnail to upload for the favorite. Currently, the only known value sent is image/wtv-bitmap
|
| favorite-url | URL for the favorite to point to. This can be a service URL or a normal website URL |