net.bis5.mattermost.client4.api

Interface PreferencesApi

All Known Implementing Classes:

MattermostClient

public interface PreferencesApi

Preferences API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<Boolean>	deletePreferences(String userId, Preferences preferences) deletes the user's preferences.
ApiResponse<Preference>	getPreferenceByCategoryAndName(String userId, PreferenceCategory category, String preferenceName) returns the user's preferences from the provided category and preference name string.
ApiResponse<Preferences>	getPreferences(String userId) returns the user's preferences.
ApiResponse<Preferences>	getPreferencesByCategory(String userId, PreferenceCategory category) returns the user's preferences from the provided category string.
ApiResponse<Boolean>	updatePreferences(String userId, Preferences perferences) saves the user's preferences.

Method Detail

getPreferences

ApiResponse<Preferences> getPreferences(String userId)

returns the user's preferences.

updatePreferences

ApiResponse<Boolean> updatePreferences(String userId,
                                       Preferences perferences)

saves the user's preferences.

deletePreferences

ApiResponse<Boolean> deletePreferences(String userId,
                                       Preferences preferences)

deletes the user's preferences.

getPreferencesByCategory

ApiResponse<Preferences> getPreferencesByCategory(String userId,
                                                  PreferenceCategory category)

returns the user's preferences from the provided category string.

getPreferenceByCategoryAndName

ApiResponse<Preference> getPreferenceByCategoryAndName(String userId,
                                                       PreferenceCategory category,
                                                       String preferenceName)

returns the user's preferences from the provided category and preference name string.