SetSchemaRequest.Builder.SetSchemaTypeWipeoutAccountPropertyPaths Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Configures the property paths within a specific schema type that are associated with a account, enabling AppSearch to automatically wipe out GenericDocuments when that account is removed.
[Android.Runtime.Register("setSchemaTypeWipeoutAccountPropertyPaths", "(Ljava/lang/String;Ljava/util/Set;Z)Landroid/app/appsearch/SetSchemaRequest$Builder;", "", ApiSince=37)]
public Android.App.AppSearch.SetSchemaRequest.Builder SetSchemaTypeWipeoutAccountPropertyPaths(string schemaType, System.Collections.Generic.ICollection<Android.App.AppSearch.PropertyPath> accountPropertyPaths, bool autoWipeout);[<Android.Runtime.Register("setSchemaTypeWipeoutAccountPropertyPaths", "(Ljava/lang/String;Ljava/util/Set;Z)Landroid/app/appsearch/SetSchemaRequest$Builder;", "", ApiSince=37)>]
member this.SetSchemaTypeWipeoutAccountPropertyPaths : string * System.Collections.Generic.ICollection<Android.App.AppSearch.PropertyPath> * bool -> Android.App.AppSearch.SetSchemaRequest.BuilderParameters
- schemaType
- String
The name of the schema type being configured (e.g., "Email"). This value cannot be null.
- accountPropertyPaths
- ICollection<PropertyPath>
A Set of property paths (e.g., "sender.account") point to the field containing the account identifier. This value cannot be null.
- autoWipeout
- Boolean
If true, enables automatic account wipeout for the given paths. If false, disables it.
Returns
This Builder instance. This value cannot be null.
- Attributes
Remarks
Configures the property paths within a specific schema type that are associated with a account, enabling AppSearch to automatically wipe out GenericDocuments when that account is removed.
To enable AppSearch to automatically wipe out documents when an account is removed, you must use this API to configure the account property paths for the relevant schema type. If this configuration is not set for a schema type, AppSearch will not automatically delete any GenericDocuments of that type, even if the account associated with the document is removed from the system. Documents will only be deleted if the app explicitly calls for their removal.
The property path must point to a AppSearchSchema.DocumentPropertyConfig which is AppSearch built-in account. The property path could point to the nested document.
When putting a GenericDocument into AppSearch, all accounts identified by the given accountPropertyPaths within that document must already exist. AppSearch will reject the document if any account specified by these paths is not recognized.
Subsequent calls for the same schemaType are additive. When autoWipeout is true, new paths are merged into the existing configuration; when false, the specified paths are removed. This allows you to incrementally manage multiple account-associated fields within a single schema.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.