Module: alfresco/services/_PreferenceServiceTopicMixin

alfresco/services/_PreferenceServiceTopicMixin

Deprecated:
  • Since 1.0.38 - Use topics instead.
    Author:
    • Dave Draper
    Copyright:
    • Copyright (C) 2005-2020 Alfresco Software Limited
    License:
    Source:

    Members

    addFavouriteDocumentFailureTopic :string

    This topic is used to indicate that a node could not be made a favourite
    Type:
    • string
    Deprecated:
    • Since 1.0.38 - no longer required within main Aikau codebase.
      Default Value:
      • "ALF_PREFERENCE_ADD_DOCUMENT_FAVOURITE_FAILURE"
      Source:

      addFavouriteDocumentSuccessTopic :string

      This topic is used to indicate that a node was successfully made a favourite.
      Type:
      • string
      Deprecated:
      • Since 1.0.38 - no longer required within main Aikau codebase.
        Default Value:
        • "ALF_PREFERENCE_ADD_DOCUMENT_FAVOURITE_SUCCESS"
        Source:

        addFavouriteDocumentTopic :string

        This topic is used to request that a node should be made a favourite.
        Type:
        • string
        Source:

        removeFavouriteDocumentFailureTopic :string

        This topic is used to indicate that a node could not be removed as a favourite
        Type:
        • string
        Deprecated:
        • Since 1.0.38 - no longer required within main Aikau codebase.
          Default Value:
          • "ALF_PREFERENCE_REMOVE_DOCUMENT_FAVOURITE_FAILURE"
          Source:

          removeFavouriteDocumentSuccessTopic :string

          This topic is used to indicate that a node was successfully removed from being a favourite.
          Type:
          • string
          Deprecated:
          • Since 1.0.38 - no longer required within main Aikau codebase.
            Default Value:
            • "ALF_PREFERENCE_REMOVE_DOCUMENT_FAVOURITE_SUCCESS"
            Source:

            removeFavouriteDocumentTopic :string

            This topic is used to request that a node should be made a favourite.
            Type:
            • string
            Source:

            Events

            getPreferenceTopic

            Type:
            • string
            Properties:
            Name Type Description
            preference string A dot-notation property of the preference to retrieve
            callback function The function to call when the preference has been retrieved
            callbackScope object The scope with which to call the callback function
            Source:

            setPreferenceTopic

            Type:
            • string
            Properties:
            Name Type Description
            preference string A dot-notation property of the preference to set
            value object The value to set as the preference
            updatedValue object The value that has been changed (e.g. this might be an item removed that)
            Source: