@PublicApi
public interface EffectorInstanceManager
effector instances
.Modifier and Type | Method and Description |
---|---|
long |
createEffectorInstance(String moduleKey,
Map<String,Object> parameters,
Long owningStructure)
Creates a new effector instance and returns its ID.
|
void |
deleteEffectorInstance(long id)
Deletes an effector instance with the given ID.
|
EffectorInstance |
getEffectorInstance(long id)
Returns an effector instance by its ID.
|
void |
updateEffectorInstance(long id,
String moduleKey,
Map<String,Object> parameters,
Long owningStructure)
Updates an effector instance with the given ID.
|
long createEffectorInstance(@NotNull String moduleKey, @Nullable Map<String,Object> parameters, @Nullable Long owningStructure) throws StructureException
moduleKey
- the module key of the Effector
parameters
- effector-specific parametersowningStructure
- the ID of the structure this instance will be
installed into, if applicable. It's always safe to pass null
here,
Structure will set this parameter when needed.StructureException
- if an effector instance cannot be created@NotNull EffectorInstance getEffectorInstance(long id) throws StructureException
id
- instance IDStructureException
- if an effector instance with this ID does not
exist or cannot be returnedvoid updateEffectorInstance(long id, @NotNull String moduleKey, @Nullable Map<String,Object> parameters, @Nullable Long owningStructure) throws StructureException
id
- instance IDmoduleKey
- the module key of the Effector
parameters
- effector-specific parametersowningStructure
- the ID of the structure this instance will be
installed into, if applicable.StructureException
- if an effector instance with this ID does not
exist or cannot be updatedvoid deleteEffectorInstance(long id) throws StructureException
id
- instance IDStructureException
- if an effector instance cannot be deletedCopyright © 2024 Tempo Software. All Rights Reserved.