IXKeeperMetadata
Functions
automationVaultMetadata
Returns the metadata of the automation vault
function automationVaultMetadata(IAutomationVault _automationVault)
external
view
returns (string calldata _name, string calldata _description);
Parameters
Name | Type | Description |
---|---|---|
_automationVault | IAutomationVault | The automation vault |
Returns
Name | Type | Description |
---|---|---|
_name | string | The name of the automation vault |
_description | string | The description of the automation vault |
automationVaultsMetadata
Returns the metadata of the automation vault
function automationVaultsMetadata(IAutomationVault[] calldata _automationVault)
external
view
returns (IXKeeperMetadata.AutomationVaultMetadata[] memory _metadata);
Parameters
Name | Type | Description |
---|---|---|
_automationVault | IAutomationVault[] | The automation vaults |
Returns
Name | Type | Description |
---|---|---|
_metadata | IXKeeperMetadata.AutomationVaultMetadata[] | The metadata of the automation vault |
setAutomationVaultMetadata
Sets the metadata of the automation vault
function setAutomationVaultMetadata(
IAutomationVault _automationVault,
AutomationVaultMetadata calldata _automationVaultMetadata
) external;
Parameters
Name | Type | Description |
---|---|---|
_automationVault | IAutomationVault | The automation vault |
_automationVaultMetadata | AutomationVaultMetadata | The metadata of the automation vault |
Events
AutomationVaultMetadataSetted
Emitted when the metadata of an automation vault is set
event AutomationVaultMetadataSetted(IAutomationVault indexed _automationVault, string _name, string _description);
Parameters
Name | Type | Description |
---|---|---|
_automationVault | IAutomationVault | The automation vault |
_name | string | The name of the automation vault |
_description | string | The description of the automation vault |
Errors
XKeeperMetadata_OnlyAutomationVaultOwner
The caller is not the owner of the automation vault
error XKeeperMetadata_OnlyAutomationVaultOwner();
Structs
AutomationVaultMetadata
The metadata of the automation vault
struct AutomationVaultMetadata {
string name;
string description;
}
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the automation vault |
description | string | The description of the automation vault |