The 'YChat! IM Web Proxy' should to be deployed with Tomcat. Once deployed, the YChat! IM Web Proxy can be accessed using http://localhost:8080/YahooIMWebProxy/ on a local machine. The YChat! Client can then call the following parameters and URLs of the 'YChat! IM Web Proxy' to perform various functions of Instant Messaging.
Here's the full list of URLs with the corresponding parameters:
Access the proxy status or base URL:
http://localhost:8080/YahooIMWebProxy/
Access the login screen:
http://localhost:8080/YahooIMWebProxy/?cmd=Login&userID=[test_yim]&userPWD=[userPassword]
Retrieve the buddy list:
http://localhost:8080/YahooIMWebProxy/?cmd=getbuddylist
Note: After logging in, the URL above is called to retrieve the buddy list in XML format.
Access the logout screen:
http://localhost:8080/YahooIMWebProxy/?cmd=logout
Send a message:
http://localhost:8080/YahooIMWebProxy/?cmd=sendMessage&sendMessageTo=[yahooBuddyUserId]&message=[message]
Note: After the user has logged in, the YChat! Instant Messenger application uses the URL listed above to send messages.
Receive a message:
http://localhost:8080/YahooIMWebProxy/?cmd=receiveMessage&receiveMessageFor=[yahooBuddyUserId]
Note: After the user has logged in, the YChat! Instant Messenger application uses the URL listed above to receive messages.
Set a custom status message:
http://localhost:8080/YahooIMWebProxy/?cmd=customStatusMessage&statusMessage=[CustomStatusMessage]
Delete a buddy from the buddy list:
http://localhost:8080/YahooIMWebProxy/?cmd=removeFriend&friendName=[yahooBuddyUserId]&groupName=[buddyGroupName]
Note: After the user has logged in, the YChat! Instant Messenger application uses the URL above to remove buddies from the buddy list.
Add a new buddy to the buddy list:
http://localhost:8080/YahooIMWebProxy/?cmd=addFriend&friendName=[newBuddyUserId]&groupName=[buddyGroupName]
Note: After the user has logged in, the YChat! Instant Messenger application uses the URL listed above to add new chat buddies to a group.
Upload a file to the server using the KuneriLite Plug-in:
http://localhost:8080/UploadServlet/
Transfer File from proxy to Yahoo IM server:
http://localhost:8080/YahooIMWebProxy/?cmd=sendFile&sendFileTo=[yahooBuddyUserId]&fileName=[fileNameThatWasXferedUsingUploadServlet ]