client.adminwebsocket.md

Home > @holochain/client > AdminWebsocket

AdminWebsocket class

A class for interacting with a conductor's Admin API.

Signature:

export declare class AdminWebsocket implements AdminApi 

Implements: AdminApi

Properties

Property	Modifiers	Type	Description
addAgentInfo		Requester<AddAgentInfoRequest, AddAgentInfoResponse>	Add an existing agent to Holochain.
agentInfo		Requester<AgentInfoRequest, AgentInfoResponse>	Request all available info about an agent.
attachAppInterface		Requester<AttachAppInterfaceRequest, AttachAppInterfaceResponse>	Send a request to open the given port for AppWebsocket connections.
authorizeSigningCredentials		(cellId: CellId, functions?: GrantedFunctions) => Promise<void>	Generate and authorize a new key pair for signing zome calls.
client	readonly	WsClient	The websocket client used for transporting requests and responses.
defaultTimeout		number	Default timeout for any request made over the websocket.
deleteCloneCell		Requester<DeleteCloneCellRequest, DeleteCloneCellResponse>	Delete a disabled clone cell.
disableApp		Requester<DisableAppRequest, DisableAppResponse>	Disable a running app.
dumpFullState		Requester<DumpFullStateRequest, DumpFullStateResponse>	Dump the full state of the specified cell, including its chain and DHT shard, as JSON.
dumpNetworkStats		Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>
dumpState		Requester<DumpStateRequest, DumpStateResponse>	Dump the state of the specified cell, including its source chain, as JSON.
enableApp		Requester<EnableAppRequest, EnableAppResponse>	Enable a stopped app.
generateAgentPubKey		Requester<GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse>	Generate a new agent pub key.
getCompatibleCells		Requester<GetCompatibleCellsRequest, GetCompatibleCellsResponse>
getDnaDefinition		Requester<GetDnaDefinitionRequest, GetDnaDefinitionResponse>	Get the DNA definition for the specified DNA hash.
grantSigningKey		(cellId: CellId, functions: GrantedFunctions, signingKey: AgentPubKey) => Promise<CapSecret>	Grant a capability for signing zome calls.
grantZomeCallCapability		Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>	Grant a zome call capability for an agent, to be used for signing zome calls.
installApp		Requester<InstallAppRequest, InstallAppResponse>	Install the specified app into Holochain.
issueAppAuthenticationToken		Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>
listAppInterfaces		Requester<ListAppInterfacesRequest, ListAppInterfacesResponse>	List all attached app interfaces.
listApps		Requester<ListAppsRequest, ListAppsResponse>	List all installed apps.
listCellIds		Requester<ListCellIdsRequest, ListCellIdsResponse>	List all installed cell ids.
listDnas		Requester<ListDnasRequest, ListDnasResponse>	List all registered DNAs.
registerDna		Requester<RegisterDnaRequest, RegisterDnaResponse>	Register a DNA for later app installation. Stores the given DNA into the Holochain DNA database and returns the hash of it.
revokeAgentKey		Requester<RevokeAgentKeyRequest, RevokeAgentKeyResponse>	Generate a new agent pub key.
storageInfo		Requester<StorageInfoRequest, StorageInfoResponse>
uninstallApp		Requester<UninstallAppRequest, UninstallAppResponse>	Uninstall the specified app from Holochain.
updateCoordinators		Requester<UpdateCoordinatorsRequest, UpdateCoordinatorsResponse>	Update coordinators for an installed app.

Methods

Method	Modifiers	Description
_requester(tag, transformer)
connect(options)	static	Factory mehtod to create a new instance connected to the given URL.