de.westnordost.osmapi.user

Class UserPreferencesApi

java.lang.Object

de.westnordost.osmapi.user.UserPreferencesApi

public class UserPreferencesApi
extends java.lang.Object

Get and set the user's custom preferences. All interactions with this class require an OsmConnection with a logged in user.

Constructor Summary

Constructors

Constructor and Description
UserPreferencesApi(de.westnordost.osmapi.OsmConnection osm)

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String key) Deletes the given preference key from the user preferences
java.lang.String	get(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getAll()
void	set(java.lang.String key, java.lang.String value) Sets the given preference key to the given preference value.
void	setAll(java.util.Map<java.lang.String,java.lang.String> preferences) Sets all the given preference keys to the given preference values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserPreferencesApi

public UserPreferencesApi(de.westnordost.osmapi.OsmConnection osm)

Method Detail

getAll

public java.util.Map<java.lang.String,java.lang.String> getAll()

Returns:

a key-value map of the user preferences

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application is not authenticated to read the user's preferences. (Permission.READ_PREFERENCES_AND_USER_DETAILS)

get

public java.lang.String get(java.lang.String key)

Parameters:

key - the preference to query

Returns:

the value of the given preference or null if the preference does not exist

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application is not authenticated to read the user's preferences. (Permission.READ_PREFERENCES_AND_USER_DETAILS)

setAll

public void setAll(java.util.Map<java.lang.String,java.lang.String> preferences)

Sets all the given preference keys to the given preference values.

Parameters:

preferences - preferences to set. Each key and each value must be less than 256 characters.

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to change the user's preferences. (Permission.CHANGE_PREFERENCES)

set

public void set(java.lang.String key,
                java.lang.String value)

Sets the given preference key to the given preference value.

Parameters:

key - preference to set. Must be less than 256 characters.

value - preference to set. Must be less than 256 characters.

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to change the user's preferences. (Permission.CHANGE_PREFERENCES)

delete

public void delete(java.lang.String key)

Deletes the given preference key from the user preferences

Parameters:

key - preference to delete. Must be less than 256 characters.

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to change the user's preferences. (Permission.CHANGE_PREFERENCES)