Contents of files stored on a OneDrive are full-text searchable using the CONTAINS() predicate. Full text searches find exact words in the body of documents, or in
a file's name. The AND operator is implied if an operator is not present between words in the
search criteria.
The following table provides example CONTAINS() predicate criteria, and the expected results:
Method Name |
Description |
CancelCheckOut(repositoryId As String, objectId As String, extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
CheckIn(repositoryId As String, objectId As String&, major As Nullable(Of Boolean), properties As IProperties, contentStream As IContentStream, checkinComment As String, policies As IList(Of String), addAces As IAcl, removeAces As IAcl, extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String& |
|
|
major |
Type: Nullable`1 |
|
|
properties |
Type: IProperties |
|
|
contentStream |
Type: IContentStream |
|
|
checkinComment |
Type: String |
|
|
policies |
Type: IList`1 |
|
|
addAces |
Type: IAcl |
|
|
removeAces |
Type: IAcl |
|
|
extension |
Type: IExtensionsData |
|
|
CheckOut(repositoryId As String, objectId As String&, extension As IExtensionsData, contentCopied As Nullable`1&) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String& |
|
|
extension |
Type: IExtensionsData |
|
|
contentCopied |
Type: Nullable`1& |
|
|
ClearAllCaches() |
|
ClearRepositoryCache(repositoryId As String) |
Parameters |
repositoryId |
Type: String |
|
|
CreateDocument(repositoryId As String, properties As IProperties, folderId As String, contentStream As IContentStream, versioningState As Nullable(Of VersioningState), policies As IList(Of String), addAces As IAcl, removeAces As IAcl, extension As IExtensionsData) As String |
Parameters |
repositoryId |
Type: String |
|
|
properties |
Type: IProperties |
|
|
folderId |
Type: String |
|
|
contentStream |
Type: IContentStream |
|
|
versioningState |
Type: Nullable`1 |
|
|
policies |
Type: IList`1 |
|
|
addAces |
Type: IAcl |
|
|
removeAces |
Type: IAcl |
|
|
extension |
Type: IExtensionsData |
|
|
CreateFolder(repositoryId As String, properties As IProperties, folderId As String, policies As IList(Of String), addAces As IAcl, removeAces As IAcl, extension As IExtensionsData) As String |
Parameters |
repositoryId |
Type: String |
|
|
properties |
Type: IProperties |
|
|
folderId |
Type: String |
|
|
policies |
Type: IList`1 |
|
|
addAces |
Type: IAcl |
|
|
removeAces |
Type: IAcl |
|
|
extension |
Type: IExtensionsData |
|
|
CreatePropDef(Id As String, Type As PropertyType, Updatability As Updatability, Options As PdOptions) As PropertyDefinition |
Parameters |
Id |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Updatability |
Type: Updatability |
|
|
Options |
Type: PdOptions |
|
|
CreatePropDef(Id As String, DisplayName As String, Type As PropertyType, Updatability As Updatability, Options As PdOptions) As PropertyDefinition |
Parameters |
Id |
Type: String |
|
|
DisplayName |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Updatability |
Type: Updatability |
|
|
Options |
Type: PdOptions |
|
|
CreatePropDef(Id As String, DisplayName As String, LocalName As String, Type As PropertyType, Updatability As Updatability, Options As PdOptions) As PropertyDefinition |
Parameters |
Id |
Type: String |
|
|
DisplayName |
Type: String |
|
|
LocalName |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Updatability |
Type: Updatability |
|
|
Options |
Type: PdOptions |
|
|
CreatePropDef(Id As String, DisplayName As String, QueryName As String, LocalName As String, Type As PropertyType, Updatability As Updatability, Options As PdOptions) As PropertyDefinition |
Parameters |
Id |
Type: String |
|
|
DisplayName |
Type: String |
|
|
QueryName |
Type: String |
|
|
LocalName |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Updatability |
Type: Updatability |
|
|
Options |
Type: PdOptions |
|
|
CreateProperty(Id As String, Type As PropertyType, Value As Object) As IPropertyData |
Parameters |
Id |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Value |
Type: Object |
|
|
CreateProperty(Id As String, Name As String, Type As PropertyType, Value As Object) As IPropertyData |
Parameters |
Id |
Type: String |
|
|
Name |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Value |
Type: Object |
|
|
CreateProperty(Id As String, Type As PropertyType, Values() As Object()) As IPropertyData |
Parameters |
Id |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Values |
Type: Object |
|
|
CreateProperty(Id As String, Name As String, Type As PropertyType, Values() As Object()) As IPropertyData |
Parameters |
Id |
Type: String |
|
|
Name |
Type: String |
|
|
Type |
Type: PropertyType |
|
|
Values |
Type: Object |
|
|
DeleteObject(repositoryId As String, objectId As String, allVersions As Nullable(Of Boolean), extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
allVersions |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
DeleteTree(repositoryId As String, folderId As String, allVersions As Nullable(Of Boolean), unfileObjects As Nullable(Of UnfileObject), continueOnFailure As Nullable(Of Boolean), extension As IExtensionsData) As IFailedToDeleteData |
Parameters |
repositoryId |
Type: String |
|
|
folderId |
Type: String |
|
|
allVersions |
Type: Nullable`1 |
|
|
unfileObjects |
Type: Nullable`1 |
|
|
continueOnFailure |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
Dispose() |
|
GetAclService() As IAclService |
|
GetAllowableActions(repositoryId As String, objectId As String, extension As IExtensionsData) As IAllowableActions |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
GetBaseDocumentPropDefs(Inherited As Boolean, IncludeVersioning As Boolean) As IEnumerable(Of IPropertyDefinition) |
Parameters |
Inherited |
Type: Boolean |
|
|
IncludeVersioning |
Type: Boolean |
|
|
GetBaseFolderPropDefs(Inherited As Boolean) As IEnumerable(Of IPropertyDefinition) |
Parameters |
Inherited |
Type: Boolean |
|
|
GetBaseUrl(RepId As String) As String |
Parameters |
RepId |
Type: String |
|
|
GetChildren(repositoryId As String, folderId As String, filter As String, orderBy As String, includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, includePathSegment As Nullable(Of Boolean), maxItems As Nullable(Of BigInteger), skipCount As Nullable(Of BigInteger), extension As IExtensionsData) As IObjectInFolderList |
Parameters |
repositoryId |
Type: String |
|
|
folderId |
Type: String |
|
|
filter |
Type: String |
|
|
orderBy |
Type: String |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
includePathSegment |
Type: Nullable`1 |
|
|
maxItems |
Type: Nullable`1 |
|
|
skipCount |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetContentStream(repositoryId As String, objectId As String, streamId As String, offset As Nullable(Of BigInteger), length As Nullable(Of BigInteger), extension As IExtensionsData) As IContentStream |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
streamId |
Type: String |
|
|
offset |
Type: Nullable`1 |
|
|
length |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetDescendants(repositoryId As String, folderId As String, depth As Nullable(Of BigInteger), filter As String, includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, includePathSegment As Nullable(Of Boolean), extension As IExtensionsData) As IList(Of IObjectInFolderContainer) |
Parameters |
repositoryId |
Type: String |
|
|
folderId |
Type: String |
|
|
depth |
Type: Nullable`1 |
|
|
filter |
Type: String |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
includePathSegment |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetDiscoveryService() As IDiscoveryService |
|
GetFolderIcon(TypeId As String) As Image |
Parameters |
TypeId |
Type: String |
|
|
GetFolderParent(repositoryId As String, folderId As String, filter As String, extension As IExtensionsData) As IObjectData |
Parameters |
repositoryId |
Type: String |
|
|
folderId |
Type: String |
|
|
filter |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
GetFolderTree(repositoryId As String, folderId As String, depth As Nullable(Of BigInteger), filter As String, includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, includePathSegment As Nullable(Of Boolean), extension As IExtensionsData) As IList(Of IObjectInFolderContainer) |
Parameters |
repositoryId |
Type: String |
|
|
folderId |
Type: String |
|
|
depth |
Type: Nullable`1 |
|
|
filter |
Type: String |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
includePathSegment |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetMultiFilingService() As IMultiFilingService |
|
GetNavigationService() As INavigationService |
|
GetObject(repositoryId As String, objectId As String, filter As String, includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, includePolicyIds As Nullable(Of Boolean), includeAcl As Nullable(Of Boolean), extension As IExtensionsData) As IObjectData |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
filter |
Type: String |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
includePolicyIds |
Type: Nullable`1 |
|
|
includeAcl |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetObjectByPath(repositoryId As String, path As String, filter As String, includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, includePolicyIds As Nullable(Of Boolean), includeAcl As Nullable(Of Boolean), extension As IExtensionsData) As IObjectData |
Parameters |
repositoryId |
Type: String |
|
|
path |
Type: String |
|
|
filter |
Type: String |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
includePolicyIds |
Type: Nullable`1 |
|
|
includeAcl |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetObjectService() As IObjectService |
|
GetParent(RepId As String, ObjectId As String, Filter As String, IncludeAllowableActions As Boolean) As IObjectData |
Parameters |
RepId |
Type: String |
|
|
ObjectId |
Type: String |
|
|
Filter |
Type: String |
|
|
IncludeAllowableActions |
Type: Boolean |
|
|
GetPolicyService() As IPolicyService |
|
GetProperties(repositoryId As String, objectId As String, filter As String, extension As IExtensionsData) As IProperties |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String |
|
|
filter |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
GetProperties() As PropertyDescriptorCollection |
|
GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
GetRelationshipService() As IRelationshipService |
|
GetRepositoryInfo(repositoryId As String, extension As IExtensionsData) As IRepositoryInfo |
Parameters |
repositoryId |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
GetRepositoryInfos(extension As IExtensionsData) As IList(Of IRepositoryInfo) |
Parameters |
extension |
Type: IExtensionsData |
|
|
GetRepositoryService() As IRepositoryService |
|
GetTypeChildren(repositoryId As String, typeId As String, includePropertyDefinitions As Nullable(Of Boolean), maxItems As Nullable(Of BigInteger), skipCount As Nullable(Of BigInteger), extension As IExtensionsData) As ITypeDefinitionList |
Parameters |
repositoryId |
Type: String |
|
|
typeId |
Type: String |
|
|
includePropertyDefinitions |
Type: Nullable`1 |
|
|
maxItems |
Type: Nullable`1 |
|
|
skipCount |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetTypeDefinition(repositoryId As String, typeId As String, extension As IExtensionsData) As ITypeDefinition |
Parameters |
repositoryId |
Type: String |
|
|
typeId |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
GetTypeDescendants(repositoryId As String, typeId As String, depth As Nullable(Of BigInteger), includePropertyDefinitions As Nullable(Of Boolean), extension As IExtensionsData) As IList(Of ITypeDefinitionContainer) |
Parameters |
repositoryId |
Type: String |
|
|
typeId |
Type: String |
|
|
depth |
Type: Nullable`1 |
|
|
includePropertyDefinitions |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
GetVersioningService() As IVersioningService |
|
Initialize(session As IBindingSession) |
Parameters |
session |
Type: IBindingSession |
|
|
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the enabled state for. |
|
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the visible state for. |
|
IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters |
Type |
Type: Type |
The type to check. |
|
MoveObject(repositoryId As String, objectId As String&, targetFolderId As String, sourceFolderId As String, extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String& |
|
|
targetFolderId |
Type: String |
|
|
sourceFolderId |
Type: String |
|
|
extension |
Type: IExtensionsData |
|
|
Query(repositoryId As String, statement As String, searchAllVersions As Nullable(Of Boolean), includeAllowableActions As Nullable(Of Boolean), includeRelationships As Nullable(Of IncludeRelationships), renditionFilter As String, maxItems As Nullable(Of BigInteger), skipCount As Nullable(Of BigInteger), extension As IExtensionsData) As IObjectList |
Parameters |
repositoryId |
Type: String |
|
|
statement |
Type: String |
|
|
searchAllVersions |
Type: Nullable`1 |
|
|
includeAllowableActions |
Type: Nullable`1 |
|
|
includeRelationships |
Type: Nullable`1 |
|
|
renditionFilter |
Type: String |
|
|
maxItems |
Type: Nullable`1 |
|
|
skipCount |
Type: Nullable`1 |
|
|
extension |
Type: IExtensionsData |
|
|
Serialize() As String |
Serializes the object. |
SetContentStream(repositoryId As String, objectId As String&, overwriteFlag As Nullable(Of Boolean), changeToken As String&, contentStream As IContentStream, extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String& |
|
|
overwriteFlag |
Type: Nullable`1 |
|
|
changeToken |
Type: String& |
|
|
contentStream |
Type: IContentStream |
|
|
extension |
Type: IExtensionsData |
|
|
SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
Parameters |
Database |
Type: GrooperDb |
|
|
SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) |
Sets the owner of the connected object with another object that implements the IConnected interface.
Parameters |
Owner |
Type: ConnectedObject |
|
|
SkipInitialization |
Type: Boolean |
|
|
ToString() As String |
Returns a string value representation of the connected object. |
UpdateProperties(repositoryId As String, objectId As String&, changeToken As String&, properties As IProperties, extension As IExtensionsData) |
Parameters |
repositoryId |
Type: String |
|
|
objectId |
Type: String& |
|
|
changeToken |
Type: String& |
|
|
properties |
Type: IProperties |
|
|
extension |
Type: IExtensionsData |
|
|
ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |