OKMNote

From OpenKM Documentation
Revision as of 10:36, 21 October 2010 by Pavila (talk | contribs) (Note add(String token, String nodePath, String text))

Jump to: navigation, search

Methods related to document notes management.

Note add(String token, String nodePath, String text)

Add a note to a document.

Parameters

  • token - The session authorization token.
  • nodePath - The path that identifies an unique document.
  • text - The message text.

Returns

  • A note object with the new created note properties.

Throws

  • LockException - A locked document can't be modified.
  • PathNotFoundException - If there is no document in the repository with this path.
  • AccessDeniedException - If there is any security problem: you can't access this document because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Since

  • OpenKM 5.0

Note get(String token, String notePath)

void remove(String token, String notePath)

void set(String token, String notePath, String text)

Note[] list(String token, String nodePath)