Language

AppSearchSchema.StringPropertyConfig.DeletePropagationTypePropagateFrom Field

Definition

Caution

This constant will be removed in the future version. Use Android.App.AppSearch.AppSearchSchemaDeletePropagationType enum directly instead of this field.

Content in this string property will be used as a qualified id referring to another (parent) document, and the deletion of the referenced document will propagate to this (child) document.

[Android.Runtime.Register("DELETE_PROPAGATION_TYPE_PROPAGATE_FROM", ApiSince=37)]
[System.Obsolete("This constant will be removed in the future version. Use Android.App.AppSearch.AppSearchSchemaDeletePropagationType enum directly instead of this field.", true)]
public const Android.App.AppSearch.AppSearchSchemaDeletePropagationType DeletePropagationTypePropagateFrom = 1;
[<Android.Runtime.Register("DELETE_PROPAGATION_TYPE_PROPAGATE_FROM", ApiSince=37)>]
[<System.Obsolete("This constant will be removed in the future version. Use Android.App.AppSearch.AppSearchSchemaDeletePropagationType enum directly instead of this field.", true)>]
val mutable DeletePropagationTypePropagateFrom : Android.App.AppSearch.AppSearchSchemaDeletePropagationType

Field Value

Value = 1
Attributes

Remarks

Content in this string property will be used as a qualified id referring to another (parent) document, and the deletion of the referenced document will propagate to this (child) document.

Please note that this propagates further. If the child document has any children that also set delete propagation type PROPAGATE_FROM for their joinable properties, then those (grandchild) documents will be deleted.

Since delete propagation works between the document and the referenced document, if setting this type for delete propagation, the string property should also be qualified id joinable (i.e. having StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID for the joinable value type). Otherwise, throw IllegalStateException when building (see StringPropertyConfig.Builder.build).

Android reference for android.app.appsearch.AppSearchSchema.StringPropertyConfig.DELETE_PROPAGATION_TYPE_PROPAGATE_FROM.

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.

Applies to