fr.toutatice.ecm.platform.collab.tools.notifications

Interface DocumentNotificationInfosProvider

All Superinterfaces:

fr.toutatice.ecm.platform.core.services.infos.provider.DocumentInformationsProvider

All Known Implementing Classes:

DocumentNotificationInfosProviderImpl

public interface DocumentNotificationInfosProvider
extends fr.toutatice.ecm.platform.core.services.infos.provider.DocumentInformationsProvider

Service for managing notifications

Author:

lbillon

Method Summary

Modifier and Type	Method and Description
org.nuxeo.ecm.core.api.DocumentModelList	getUserSubscriptions(org.nuxeo.ecm.core.api.CoreSession coreSession) Return a list of documents followed by the current user
void	subscribe(org.nuxeo.ecm.core.api.CoreSession coreSession, org.nuxeo.ecm.core.api.DocumentModel currentDocument) Subscribe to all notifications on the document
void	unsubscribe(org.nuxeo.ecm.core.api.CoreSession coreSession, org.nuxeo.ecm.core.api.DocumentModel currentDocument) Remove all subscriptions to notifications on the document
void	workspaceUnsubscribe(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel workspace, String user) Remove all subscriptions to notifications on the documents in the given workspace

Methods inherited from interface fr.toutatice.ecm.platform.core.services.infos.provider.DocumentInformationsProvider

fetchInfos

Method Detail

subscribe

void subscribe(org.nuxeo.ecm.core.api.CoreSession coreSession,
               org.nuxeo.ecm.core.api.DocumentModel currentDocument)

Subscribe to all notifications on the document

Parameters:

coreSession -

currentDocument -

unsubscribe

void unsubscribe(org.nuxeo.ecm.core.api.CoreSession coreSession,
                 org.nuxeo.ecm.core.api.DocumentModel currentDocument)
          throws org.nuxeo.ecm.core.api.ClientException,
                 ClassNotFoundException

Remove all subscriptions to notifications on the document

Parameters:

coreSession -

currentDocument -

Throws:

org.nuxeo.ecm.core.api.ClientException

ClassNotFoundException

workspaceUnsubscribe

void workspaceUnsubscribe(org.nuxeo.ecm.core.api.CoreSession session,
                          org.nuxeo.ecm.core.api.DocumentModel workspace,
                          String user)
                   throws org.nuxeo.ecm.core.api.ClientException,
                          ClassNotFoundException

Remove all subscriptions to notifications on the documents in the given workspace

Parameters:

session -

user -

document -

Throws:

org.nuxeo.ecm.core.api.ClientException

ClassNotFoundException

getUserSubscriptions

org.nuxeo.ecm.core.api.DocumentModelList getUserSubscriptions(org.nuxeo.ecm.core.api.CoreSession coreSession)

Return a list of documents followed by the current user

Parameters:

coreSession -

Returns:

list of followed documents