DocumentAccess¶
-
class
OC\FullTextSearch\Model\
DocumentAccess
¶ - Class 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 IndexDocumentDuring the search, it is internally use to define to which group, circles, ...a user that perform the search belongs to.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#52 Implements: OCP\FullTextSearch\Model\IDocumentAccess
JsonSerializable
Properties¶
Methods¶
-
public
OC\FullTextSearch\Model\DocumentAccess::
__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
OC\FullTextSearch\Model\DocumentAccess::
setOwnerId
($ownerId)¶ - Set the Owner of the document.
Source: Parameters: - $ownerId (string)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
getOwnerId
()¶ - Get the Owner of the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#110 Since: 16.0.0 Returns: string
-
public
OC\FullTextSearch\Model\DocumentAccess::
setViewerId
($viewerId)¶ - Set the viewer of the document.
Source: Parameters: - $viewerId (string)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
getViewerId
()¶ - Get the viewer of the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#137 Since: 16.0.0 Returns: string
-
public
OC\FullTextSearch\Model\DocumentAccess::
setUsers
($users)¶ - Set the list of users that have read access to the document.
Source: Parameters: - $users (array)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
getUsers
()¶ - Get the complete list of users that have read access to the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#195 Since: 16.0.0 Returns: array
-
public
OC\FullTextSearch\Model\DocumentAccess::
setGroups
($groups)¶ - Set the list of groups that have read access to the document.
Source: Parameters: - $groups (array)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
getGroups
()¶ - Get the complete list of groups that have read access to the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#253 Since: 16.0.0 Returns: array
-
public
OC\FullTextSearch\Model\DocumentAccess::
setCircles
($circles)¶ - Set the list of circles that have read access to the document.
Source: Parameters: - $circles (array)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
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
OC\FullTextSearch\Model\DocumentAccess::
getCircles
()¶ - Get the complete list of circles that have read access to the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#311 Since: 16.0.0 Returns: array
-
public
OC\FullTextSearch\Model\DocumentAccess::
setLinks
($links)¶ - Set the list of links that have read access to the document.
Source: Parameters: - $links (array)
Since: 16.0.0
Returns:
-
public
OC\FullTextSearch\Model\DocumentAccess::
getLinks
()¶ - Get the list of links that have read access to the document.
Source: lib/private/FullTextSearch/Model/DocumentAccess.php#338 Since: 16.0.0 Returns: array
-
public
OC\FullTextSearch\Model\DocumentAccess::
jsonSerialize
()¶ Source: lib/private/FullTextSearch/Model/DocumentAccess.php#348 Since: 16.0.0 Returns: array