block

package
v0.0.0-...-8ff1004 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2019 License: AGPL-3.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client allows access to the block API end point.

func NewClient

func NewClient(st base.APICallCloser) *Client

NewClient creates a new client for accessing the block API.

func (*Client) List

func (c *Client) List() ([]params.Block, error)

List returns blocks that are switched on for current model.

func (*Client) SwitchBlockOff

func (c *Client) SwitchBlockOff(blockType string) error

SwitchBlockOff switches desired block off for the current model. Valid block types are "BlockDestroy", "BlockRemove" and "BlockChange".

func (*Client) SwitchBlockOn

func (c *Client) SwitchBlockOn(blockType, msg string) error

SwitchBlockOn switches desired block on for the current model. Valid block types are "BlockDestroy", "BlockRemove" and "BlockChange".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL