Login service

login

LoginService.login(String username,
                   String password,
                   int sessionTimeoutMinutes)

Authorize the current session. The client must keep the returned session cookie and has to submit that cookie with each other request to identify the session on the server. The username and password are the ones from any MyTunesRSS user. The session timeout is given in minutes. The function either returns a session ID or an error in case the user could not be authorized.

logout

LoginService.logout()

Logout the current user and kill the session on the server. All session data is lost and the session ID gets invalid.

ping

LoginService.ping()

Ping the session specified though the path info or the special header. The session is touched so you can use this function to keep the session alive. This function can also be used to check whether or not the specified session is valid since it returns TRUE for a valid session ID and FALSE for an invalid session ID.

getUserInfo

LoginService.getUserInfo()

Get information about the currently logged in user.

saveUserSettings

LoginService.saveUserSettings(String password,
                              String email,
                              String lastFmUser,
                              String lastFmPassword)

Save some user settings. If a value is NULL or the user does not have the permission to set/change the value (call getUserInfo for getting those permissions) it remains unchanged. So you cannot clear the values but you can only change them to something not blank. All values are trimmed before saving.

© 2010 Codewave Software - Michael Descher