Enum holochain_conductor_api::AdminRequest

pub enum AdminRequest {
    AddAdminInterfaces(Vec<AdminInterfaceConfig>),
    RegisterDna(Box<RegisterDnaPayload>),
    CreateCloneCell(Box<CreateCloneCellPayload>),
    InstallApp(Box<InstallAppPayload>),
    InstallAppBundle(Box<InstallAppBundlePayload>),
    UninstallApp {
        installed_app_id: InstalledAppId,
    },
    ListDnas,
    GenerateAgentPubKey,
    ListCellIds,
    ListEnabledApps,
    ListActiveApps,
    ListApps {
        status_filter: Option<AppStatusFilter>,
    },
    EnableApp {
        installed_app_id: InstalledAppId,
    },
    ActivateApp {
        installed_app_id: InstalledAppId,
    },
    DisableApp {
        installed_app_id: InstalledAppId,
    },
    DeactivateApp {
        installed_app_id: InstalledAppId,
    },
    StartApp {
        installed_app_id: InstalledAppId,
    },
    AttachAppInterface {
        port: Option<u16>,
    },
    ListAppInterfaces,
    DumpState {
        cell_id: Box<CellId>,
    },
    AddAgentInfo {
        agent_infos: Vec<AgentInfoSigned>,
    },
    RequestAgentInfo {
        cell_id: Option<CellId>,
    },
}

Represents the available conductor functions to call over an Admin interface and will result in a corresponding AdminResponse message being sent back over the interface connection. Enum variants follow a general convention of verb_noun as opposed to the noun_verb of AdminResponse.

Expects a serialized object with any contents of the enum on a key data and the enum variant on a key type, e.g. { type: 'enable_app', data: { installed_app_id: 'test_app' } }

Variants

AddAdminInterfaces(Vec<AdminInterfaceConfig>)

Set up and register one or more new Admin interfaces as specified by a list of configurations. See AdminInterfaceConfig for details on the configuration.

Will be responded to with an AdminResponse::AdminInterfacesAdded or an AdminResponse::Error

Tuple Fields of AddAdminInterfaces

0: Vec<AdminInterfaceConfig>

RegisterDna(Box<RegisterDnaPayload>)

Register a DNA for later use in InstallApp Stores the given DNA into the holochain dnas database and returns the hash of the DNA Will be responded to with an AdminResponse::DnaRegistered or an AdminResponse::Error

Tuple Fields of RegisterDna

0: Box<RegisterDnaPayload>

CreateCloneCell(Box<CreateCloneCellPayload>)

“Clone” a DNA (in the biological sense), thus creating a new Cell.

Using the provided, already-registered DNA, create a new DNA with a unique UID and the specified properties, create a new Cell from this cloned DNA, and add the Cell to the specified App.

Will be responded to with an AdminResponse::DnaCloned or an AdminResponse::Error

Tuple Fields of CreateCloneCell

0: Box<CreateCloneCellPayload>

InstallApp(Box<InstallAppPayload>)

Install an app from a list of Dna paths. Triggers genesis to be run on all Cells and to be stored. An App is intended for use by one and only one Agent and for that reason it takes an AgentPubKey and installs all the Dnas with that AgentPubKey forming new Cells. See InstallAppPayload for full details on the configuration.

Note that the new App will not be enabled automatically after installation and can be enabled by calling AdminRequest::EnableApp.

Will be responded to with an AdminResponse::AppInstalled or an AdminResponse::Error

Tuple Fields of InstallApp

0: Box<InstallAppPayload>

InstallAppBundle(Box<InstallAppBundlePayload>)

Install an app using an AppBundle.

Triggers genesis to be run on all Cells and to be stored. An App is intended for use by one and only one Agent and for that reason it takes an AgentPubKey and installs all the Dnas with that AgentPubKey forming new Cells. See InstallAppBundlePayload for full details on the configuration.

Note that the new App will not be enabled automatically after installation and can be enabled by calling AdminRequest::EnableApp.

Will be responded to with an AdminResponse::AppInstalled or an AdminResponse::Error

Tuple Fields of InstallAppBundle

0: Box<InstallAppBundlePayload>

UninstallApp

Uninstalls the App specified by argument installed_app_id from the conductor, meaning that the app will be removed from the list of installed apps, and any Cells which were referenced only by this app will be disabled and removed, clearing up any persisted data. Cells which are still referenced by other installed apps will not be removed.

Will be responded to with an AdminResponse::AppUninstalled or an AdminResponse::Error

Fields of UninstallApp

installed_app_id: InstalledAppId

The InstalledAppId to uninstall

ListDnas

List the hashes of all installed Dnas. Takes no arguments.

Will be responded to with an AdminResponse::DnasListed or an AdminResponse::Error

GenerateAgentPubKey

Generate a new AgentPubKey. Takes no arguments.

Will be responded to with an AdminResponse::AgentPubKeyGenerated or an AdminResponse::Error

ListCellIds

List all the cell ids in the conductor. Takes no arguments.

Will be responded to with an AdminResponse::CellIdsListed or an AdminResponse::Error

ListEnabledApps

List the ids of all the enabled Apps in the conductor. Takes no arguments.

Will be responded to with an AdminResponse::ActiveAppsListed or an AdminResponse::Error

ListActiveApps

👎 Deprecated:

alias for ListEnabledApps

DEPRECATED. Alias for ListEnabledApps.

ListApps

List the ids of the Apps that are installed in the conductor, returning their information. If status_filter is Some(_), it will return only the Apps with the specified status

Will be responded to with an AdminResponse::AppsListed or an AdminResponse::Error

Fields of ListApps

status_filter: Option<AppStatusFilter>

EnableApp

Changes the App specified by argument installed_app_id from a disabled state to an enabled state in the conductor, meaning that Zome calls can now be made and the App will be loaded on a reboot of the conductor. It is likely to want to call this after calling AdminRequest::InstallApp, since a freshly installed App is not activated automatically.

Will be responded to with an AdminResponse::AppEnabled or an AdminResponse::Error

Fields of EnableApp

installed_app_id: InstalledAppId

The InstalledAppId to enable

ActivateApp

👎 Deprecated:

alias for EnableApp

DEPRECATED. Alias for EnableApp.

Fields of ActivateApp

installed_app_id: InstalledAppId

👎 Deprecated:

alias for EnableApp

The InstalledAppId to enable

DisableApp

Changes the App specified by argument installed_app_id from an enabled state to a disabled state in the conductor, meaning that Zome calls can no longer be made, and the App will not be loaded on a reboot of the conductor.

Will be responded to with an AdminResponse::AppDisabled or an AdminResponse::Error

Fields of DisableApp

installed_app_id: InstalledAppId

The InstalledAppId to disable

DeactivateApp

👎 Deprecated:

alias for DisableApp

DEPRECATED. Alias for DisableApp.

Fields of DeactivateApp

installed_app_id: InstalledAppId

👎 Deprecated:

alias for DisableApp

The InstalledAppId to disable

StartApp

Fields of StartApp

installed_app_id: InstalledAppId

The InstalledAppId to (re)start

AttachAppInterface

Open up a new websocket interface at the networking port (optionally) specified by argument port (or using any free port if argument port is None) over which you can then use the [AppRequest] API. Any active App will be callable via this interface. The successful AdminResponse::AppInterfaceAttached message will contain the port chosen by the conductor if None was passed.

Will be responded to with an AdminResponse::AppInterfaceAttached or an AdminResponse::Error

Fields of AttachAppInterface

port: Option<u16>

Optional port, use None to let the OS choose a free port

ListAppInterfaces

List all the app interfaces currently attached with [AttachAppInterface].

DumpState

Dump the full state of the Cell specified by argument cell_id, including its chain, as a string containing JSON.

Will be responded to with an AdminResponse::StateDumped or an AdminResponse::Error

Fields of DumpState

cell_id: Box<CellId>

The CellId for which to dump state

AddAgentInfo

Add a list [AgentInfoSigned] to this conductor’s peer store. This is another way of finding peers on a dht.

This can be useful for testing.

It is also helpful if you know other agents on the network and they can send you their agent info.

Fields of AddAgentInfo

agent_infos: Vec<AgentInfoSigned>

Vec of signed agent info to add to peer store

RequestAgentInfo

Request the [AgentInfoSigned] stored in this conductor’s peer store.

You can:

• Get all agent info by leaving cell id to None.
• Get a specific agent info by setting the cell id.

This is how you can send your agent info to another agent. It is also useful for testing across networks.

Fields of RequestAgentInfo

cell_id: Option<CellId>

Optionally choose a specific agent info

Trait Implementations

impl Debug for AdminRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AdminRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for AdminRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ AdminRequest> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &AdminRequest) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<AdminRequest> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: AdminRequest) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for AdminRequest

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<AdminRequest, SerializedBytesError>

Performs the conversion.