Package com.alfresco.content.apis

Interface PreferencesApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract PreferenceEntry getPreference(@Path(value = "personId") String personId, @Path(value = "preferenceName") String preferenceName, @Query(value = "fields") List<String> fields) Get a preference Gets a specific preference for person personId.
      abstract PreferencePaging listPreferences(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields) List preferences Gets a list of preferences for person personId.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getPreference

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/preferences/{preferenceName}") abstract PreferenceEntry getPreference(@Path(value = "personId") String personId, @Path(value = "preferenceName") String preferenceName, @Query(value = "fields") List<String> fields)

        Get a preference Gets a specific preference for person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

        Parameters:
        personId - The identifier of a person.
        preferenceName - The name of the preference.
        fields - A list of field names.

      • listPreferences

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/preferences") abstract PreferencePaging listPreferences(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)

        List preferences Gets a list of preferences for person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. Note that each preference consists of an id and a value. The value can be of any JSON type. The endpoint is owned by defaultname service owner

        Parameters:
        personId - The identifier of a person.
        skipCount - The number of entities that exist in the collection before those included in this list.
        maxItems - The maximum number of items to return in the list.
        fields - A list of field names.