Extensions > API reference > ConstraintCollection

ConstraintCollection

Provides access to data about a collection of ConstraintValueInfo providers. Note: This API is experimental and may change at any time. It is disabled by default, but may be enabled with --experimental_platforms_api

constraint_settings

sequence ConstraintCollection.constraint_settings

Experimental. This API is experimental and may change at any time. Please do not depend on it. It may be enabled on an experimental basis by setting --experimental_platform_api
The ConstraintSettingInfo values that this collection directly references.

get

ConstraintValueInfo ConstraintCollection.get(constraint=None)

Experimental. This API is experimental and may change at any time. Please do not depend on it. It may be enabled on an experimental basis by setting --experimental_platform_api
Returns the specific ConstraintValueInfo for a specific ConstraintSettingInfo.

Parameters

Parameter	Description
constraint	ConstraintSettingInfo The constraint setting to fetch the value for.

May return None.

has

bool ConstraintCollection.has(constraint=None)

Experimental. This API is experimental and may change at any time. Please do not depend on it. It may be enabled on an experimental basis by setting --experimental_platform_api
Returns whether the specific ConstraintSettingInfo is set.

Parameters

Parameter	Description
constraint	ConstraintSettingInfo The constraint setting to check.