ApiSessionRepartition Method |
Changes the partition configuration of a project.
The changes will be published and the project will be saved during this function.
Only certain objects can be passed to this function. Invalid objects will cause an exception.
See ObjectProxy.CanBePartitioned.
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public void Repartition( IList<ObjectProxy> aObjects, RepartitionMode aMode, bool aKeepPartitons = false )
Parameters
- aObjects
- Type: System.Collections.GenericIListObjectProxy
Objects to convert (create or retire) - aMode
- Type: Articy.ApiRepartitionMode
Defines what to do with the objects passed via aObjects - aKeepPartitons (Optional)
- Type: SystemBoolean
Set to true to keep partitions claimed after conversion
Exceptions| Exception | Condition |
|---|---|
| ArticyApiException | ObjectNotPartitionable is thrown when CanBePartitioned of an object is false |
| ArticyApiException | RepartitioningFailed is thrown when the partitioning process failed (e.g. wrong user rights) |
See Also