Class default

API implements the charms interface and is the concrete implementation of the API end point.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

charmInfo isMetered list

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/charms/CharmsV2.ts:157

Properties

NAME

NAME: string = "Charms"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Charms"

`Static` VERSION

VERSION: number = 2

Methods

charmInfo

charmInfo(params: CharmURL): Promise<Charm>
CharmInfo returns information about the requested charm. NOTE: thumper 2016-06-29, this is not a bulk call and probably should be.
Parameters
- params: CharmURL
Returns Promise<Charm>
- Defined in api/facades/charms/CharmsV2.ts:168

isMetered

isMetered(params: CharmURL): Promise<IsMeteredResult>
IsMetered returns whether or not the charm is metered.
Parameters
- params: CharmURL
Returns Promise<IsMeteredResult>
- Defined in api/facades/charms/CharmsV2.ts:184

list

list(params: CharmsList): Promise<CharmsListResult>
List returns a list of charm URLs currently in the state. If supplied parameter contains any names, the result will be filtered to return only the charms with supplied names.
Parameters
- params: CharmsList
Returns Promise<CharmsListResult>
- Defined in api/facades/charms/CharmsV2.ts:202

Generated using TypeDoc