Class default

API provides the spaces API facade for version 6.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

createSpaces listSpaces moveSubnets reloadSpaces removeSpace renameSpace showSpace

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/spaces/SpacesV6.ts:159

Properties

NAME

NAME: string = "Spaces"

VERSION

VERSION: number = 6

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Spaces"

`Static` VERSION

VERSION: number = 6

Methods

createSpaces

createSpaces(params: CreateSpacesParams): Promise<ErrorResults>
CreateSpaces creates a new Juju network space, associating the specified subnets with it (optional; can be empty).
Parameters
- params: CreateSpacesParams
Returns Promise<ErrorResults>
- Defined in api/facades/spaces/SpacesV6.ts:170

listSpaces

listSpaces(params: any): Promise<ListSpacesResults>
ListSpaces lists all the available spaces and their associated subnets.
Parameters
- params: any
Returns Promise<ListSpacesResults>
- Defined in api/facades/spaces/SpacesV6.ts:186

moveSubnets

moveSubnets(params: MoveSubnetsParams): Promise<MoveSubnetsResults>
MoveSubnets ensures that the input subnets are in the input space.
Parameters
- params: MoveSubnetsParams
Returns Promise<MoveSubnetsResults>
- Defined in api/facades/spaces/SpacesV6.ts:202

reloadSpaces

reloadSpaces(params: any): Promise<any>
ReloadSpaces refreshes spaces from substrate
Parameters
- params: any
Returns Promise<any>
- Defined in api/facades/spaces/SpacesV6.ts:218

removeSpace

removeSpace(params: RemoveSpaceParams): Promise<RemoveSpaceResults>
RemoveSpace removes a space. Returns SpaceResults if entities/settings are found which makes the deletion not possible.
Parameters
- params: RemoveSpaceParams
Returns Promise<RemoveSpaceResults>
- Defined in api/facades/spaces/SpacesV6.ts:235

renameSpace

renameSpace(params: RenameSpacesParams): Promise<ErrorResults>
RenameSpace renames a space.
Parameters
- params: RenameSpacesParams
Returns Promise<ErrorResults>
- Defined in api/facades/spaces/SpacesV6.ts:251

showSpace

showSpace(params: Entities): Promise<ShowSpaceResults>
ShowSpace shows the spaces for a set of given entities.
Parameters
- params: Entities
Returns Promise<ShowSpaceResults>
- Defined in api/facades/spaces/SpacesV6.ts:267

Generated using TypeDoc