IDocumentAccess¶
-
interface
OCP\FullTextSearch\Model\
IDocumentAccess
¶ - Interface IDocumentAccessThis object is used as a data transfer object when- indexing a document,- generating a search request.During the index, it is used to define which users, groups, circles, ...have access to the IIndexDocumentDuring the search, it is internally use to define to which group, circles, ...a user that perform the search belongs to.
Implemented by: OC\FullTextSearch\Model\DocumentAccess
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#48
Methods¶
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
__construct
($ownerId="")¶ - Owner of the document can be set at the init of the object.
Source: Parameters: - $ownerId (string)
Since: 16.0.0 IDocumentAccess constructor.
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setOwnerId
($ownerId)¶ - Set the Owner of the document.
Source: Parameters: - $ownerId (string)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getOwnerId
()¶ - Get the Owner of the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#81 Since: 16.0.0 Returns: string
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setViewerId
($viewerId)¶ - Set the viewer of the document.
Source: Parameters: - $viewerId (string)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getViewerId
()¶ - Get the viewer of the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#102 Since: 16.0.0 Returns: string
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setUsers
($users)¶ - Set the list of users that have read access to the document.
Source: Parameters: - $users (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addUser
($user)¶ - Add an entry to the list of users that have read access to the document.
Source: Parameters: - $user (string)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addUsers
($users)¶ - Add multiple entries to the list of users that have read access to thedocument.
Source: Parameters: - $users (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getUsers
()¶ - Get the complete list of users that have read access to the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#146 Since: 16.0.0 Returns: array
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setGroups
($groups)¶ - Set the list of groups that have read access to the document.
Source: Parameters: - $groups (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addGroup
($group)¶ - Add an entry to the list of groups that have read access to the document.
Source: Parameters: - $group (string)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addGroups
($groups)¶ - Add multiple entries to the list of groups that have read access to thedocument.
Source: Parameters: - $groups (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getGroups
()¶ - Get the complete list of groups that have read access to the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#190 Since: 16.0.0 Returns: array
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setCircles
($circles)¶ - Set the list of circles that have read access to the document.
Source: Parameters: - $circles (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addCircle
($circle)¶ - Add an entry to the list of circles that have read access to the document.
Source: Parameters: - $circle (string)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
addCircles
($circles)¶ - Add multiple entries to the list of groups that have read access to thedocument.
Source: Parameters: - $circles (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getCircles
()¶ - Get the complete list of circles that have read access to the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#234 Since: 16.0.0 Returns: array
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
setLinks
($links)¶ - Set the list of links that have read access to the document.
Source: Parameters: - $links (array)
Since: 16.0.0
Returns:
-
public
OCP\FullTextSearch\Model\IDocumentAccess::
getLinks
()¶ - Get the list of links that have read access to the document.
Source: lib/public/FullTextSearch/Model/IDocumentAccess.php#255 Since: 16.0.0 Returns: array