settings

Documentation

Overview

Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.

Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.

Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.

Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.

Index

• func Init(svc settings.Service)
• func NewCapabilities(inst *instance.Instance) jsonapi.Object
• func NewExternalTies(ties *csettings.ExternalTies) jsonapi.Object
• func Routes(router *echo.Group)
• type HTTPHandler
  • func NewHTTPHandler(svc csettings.Service) *HTTPHandler
  • func (h *HTTPHandler) Register(router *echo.Group)

Functions

func Init

func Init(svc settings.Service)

func NewCapabilities

func NewCapabilities(inst *instance.Instance) jsonapi.Object

NewCapabilities return a document with capabilities that can be marshaled to JSON or JSON-API.

func NewExternalTies

func NewExternalTies(ties *csettings.ExternalTies) jsonapi.Object

func Routes

func Routes(router *echo.Group)

Types

type HTTPHandler

type HTTPHandler struct {
	// contains filtered or unexported fields
}

HTTPHandler handle all the `/settings` routes.

func NewHTTPHandler

func NewHTTPHandler(svc csettings.Service) *HTTPHandler

NewHTTPHandler instantiates a new HTTPHandler.

func (*HTTPHandler) Register

func (h *HTTPHandler) Register(router *echo.Group)

Register all the `/settings` routes to the given router.