ApiCorp: Class Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions
ApiCorp Documentation  3.10.3
Class Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions

Options of documents enumeration function More details...

Public attributes

bool AddedToIndex
 Filter by whether the document has been added to your own collection's index: true - only documents added to index, false - only documents not added to index. If the filter is not specified all the documents are enumerated More details...
 
int Count
 Maximum amount of documents in pack More details...
 

Properties

int FolderId [get, set]
 ID of the folder in which the documents should be searched. If it is null the search goes through all folders More details...
 
string FromUser [get, set]
 E-mail of the user on whose behalf the documents were uploaded. This user must be registered in the system. More details...
 
bool InStorage [get, set]
 A flag that indicates where to look for documents. If it is false: in the user workspace. If it is true: in the company storage. If it is null: in all parts. More details...
 

Detailed description

Options of documents enumeration function

Class data

◆ AddedToIndex

bool Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions.AddedToIndex

Filter by whether the document has been added to your own collection's index: true - only documents added to index, false - only documents not added to index. If the filter is not specified all the documents are enumerated.

◆ Count

int Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions.Count

Maximum amount of documents in pack.

Full list of properties

◆ FolderId

int Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions.FolderId
getset

ID of the folder in which the documents should be searched. If it is null the search goes through all folders.

◆ FromUser

string Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions.FromUser
getset

E-mail of the user on whose behalf the documents were uploaded. This user must be registered in the system.

◆ InStorage

bool Antiplagiat.ApiCorp.Model.EnumerateDocumentsOptions.InStorage
getset

A flag that indicates where to look for documents. If it is false: in the user workspace. If it is true: in the company storage. If it is null: in all parts.