client

Documentation

Index

• type Client
  • func (c *Client) CheckAccessToDevicesOfGroup(token string, group models.DeviceGroup) (err error, code int)
  • func (c *Client) GetAspect(id string) (models.Aspect, error, int)
  • func (c *Client) GetAspectNode(id string) (models.AspectNode, error, int)
  • func (c *Client) GetAspectNodes() ([]models.AspectNode, error, int)
  • func (c *Client) GetAspectNodesByIdList(ids []string) (result []models.AspectNode, err error, code int)
  • func (c *Client) GetAspectNodesMeasuringFunctions(id string, ancestors bool, descendants bool) (result []models.Function, err error, errCode int)
  • func (c *Client) GetAspectNodesWithFunction(function string, ancestors bool, descendants bool) ([]models.AspectNode, error, int)
  • func (c *Client) GetAspectNodesWithMeasuringFunction(ancestors bool, descendants bool) ([]models.AspectNode, error, int)
  • func (c *Client) GetAspects() ([]models.Aspect, error, int)
  • func (c *Client) GetAspectsWithMeasuringFunction(ancestors bool, descendants bool) ([]models.Aspect, error, int)
  • func (c *Client) GetCharacteristic(id string) (result models.Characteristic, err error, errCode int)
  • func (c *Client) GetConceptWithCharacteristics(id string) (models.ConceptWithCharacteristics, error, int)
  • func (c *Client) GetConceptWithoutCharacteristics(id string) (models.Concept, error, int)
  • func (c *Client) GetDeviceClass(id string) (result models.DeviceClass, err error, errCode int)
  • func (c *Client) GetDeviceClasses() ([]models.DeviceClass, error, int)
  • func (c *Client) GetDeviceClassesControllingFunctions(id string) (result []models.Function, err error, errCode int)
  • func (c *Client) GetDeviceClassesFunctions(id string) (result []models.Function, err error, errCode int)
  • func (c *Client) GetDeviceClassesWithControllingFunctions() ([]models.DeviceClass, error, int)
  • func (c *Client) GetDeviceTypeSelectables(query []model.FilterCriteria, pathPrefix string, interactionsFilter []string, ...) (result []model.DeviceTypeSelectable, err error, code int)
  • func (c *Client) GetDeviceTypeSelectablesV2(query []model.FilterCriteria, pathPrefix string, includeModified bool, ...) (result []model.DeviceTypeSelectable, err error, code int)
  • func (c *Client) GetFunction(id string) (result models.Function, err error, errCode int)
  • func (c *Client) GetFunctionsByType(rdfType string) (result []models.Function, err error, errCode int)
  • func (c *Client) GetLeafCharacteristics() (result []models.Characteristic, err error, errCode int)
  • func (c *Client) GetLocation(id string, token string) (location models.Location, err error, errCode int)
  • func (c *Client) GetService(id string) (result models.Service, err error, code int)
  • func (c *Client) GetUsedInDeviceType(query model.UsedInDeviceTypeQuery) (result model.UsedInDeviceTypeResponse, err error, errCode int)
  • func (c *Client) ListDeviceTypes(token string, limit int64, offset int64, sort string, ...) (result []models.DeviceType, err error, errCode int)
  • func (c *Client) ListDeviceTypesV2(token string, limit int64, offset int64, sort string, ...) (result []models.DeviceType, err error, errCode int)
  • func (c *Client) ListHubDeviceIds(id string, token string, action model.AuthAction, asLocalId bool) (result []string, err error, errCode int)
  • func (c *Client) ListProtocols(token string, limit int64, offset int64, sort string) (result []models.Protocol, err error, errCode int)
  • func (c *Client) ReadDevice(id string, token string, action model.AuthAction) (result models.Device, err error, errCode int)
  • func (c *Client) ReadDeviceByLocalId(localId string, token string, action model.AuthAction) (result models.Device, err error, errCode int)
  • func (c *Client) ReadDeviceGroup(id string, token string, filterGenericDuplicateCriteria bool) (result models.DeviceGroup, err error, errCode int)
  • func (c *Client) ReadDeviceType(id string, token string) (result models.DeviceType, err error, errCode int)
  • func (c *Client) ReadHub(id string, token string, action model.AuthAction) (result models.Hub, err error, errCode int)
  • func (c *Client) ReadProtocol(id string, token string) (result models.Protocol, err error, errCode int)
  • func (c *Client) ValidateAspect(aspect models.Aspect) (err error, code int)
  • func (c *Client) ValidateAspectDelete(id string) (err error, code int)
  • func (c *Client) ValidateCharacteristicDelete(id string) (err error, code int)
  • func (c *Client) ValidateCharacteristics(characteristic models.Characteristic) (err error, code int)
  • func (c *Client) ValidateConcept(concept models.Concept) (err error, code int)
  • func (c *Client) ValidateConceptDelete(id string) (err error, code int)
  • func (c *Client) ValidateDevice(device models.Device) (err error, code int)
  • func (c *Client) ValidateDeviceClass(deviceclass models.DeviceClass) (err error, code int)
  • func (c *Client) ValidateDeviceClassDelete(id string) (err error, code int)
  • func (c *Client) ValidateDeviceGroup(deviceGroup models.DeviceGroup) (err error, code int)
  • func (c *Client) ValidateDeviceType(deviceType models.DeviceType, options model.ValidationOptions) (err error, code int)
  • func (c *Client) ValidateFunction(function models.Function) (err error, code int)
  • func (c *Client) ValidateFunctionDelete(id string) (err error, code int)
  • func (c *Client) ValidateHub(hub models.Hub) (err error, code int)
  • func (c *Client) ValidateLocation(location models.Location) (err error, code int)
  • func (c *Client) ValidateProtocol(protocol models.Protocol) (err error, code int)
• type DeviceTypeValidationOptions
• type Interface
  • func NewClient(baseUrl string) Interface
  • func NewTestClient() (ctrl Interface, db database.Database, sec *mocks.Security, err error)

Types

type Client

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

func (*Client) CheckAccessToDevicesOfGroup

func (c *Client) CheckAccessToDevicesOfGroup(token string, group models.DeviceGroup) (err error, code int)

func (*Client) GetAspect

func (c *Client) GetAspect(id string) (models.Aspect, error, int)

func (*Client) GetAspectNode

func (c *Client) GetAspectNode(id string) (models.AspectNode, error, int)

func (*Client) GetAspectNodes

func (c *Client) GetAspectNodes() ([]models.AspectNode, error, int)

func (*Client) GetAspectNodesByIdList

func (c *Client) GetAspectNodesByIdList(ids []string) (result []models.AspectNode, err error, code int)

func (*Client) GetAspectNodesMeasuringFunctions

func (c *Client) GetAspectNodesMeasuringFunctions(id string, ancestors bool, descendants bool) (result []models.Function, err error, errCode int)

func (*Client) GetAspectNodesWithFunction

func (c *Client) GetAspectNodesWithFunction(function string, ancestors bool, descendants bool) ([]models.AspectNode, error, int)

func (*Client) GetAspectNodesWithMeasuringFunction

func (c *Client) GetAspectNodesWithMeasuringFunction(ancestors bool, descendants bool) ([]models.AspectNode, error, int)

func (*Client) GetAspects

func (c *Client) GetAspects() ([]models.Aspect, error, int)

func (*Client) GetAspectsWithMeasuringFunction

func (c *Client) GetAspectsWithMeasuringFunction(ancestors bool, descendants bool) ([]models.Aspect, error, int)

func (*Client) GetCharacteristic

func (c *Client) GetCharacteristic(id string) (result models.Characteristic, err error, errCode int)

func (*Client) GetConceptWithCharacteristics

func (c *Client) GetConceptWithCharacteristics(id string) (models.ConceptWithCharacteristics, error, int)

func (*Client) GetConceptWithoutCharacteristics

func (c *Client) GetConceptWithoutCharacteristics(id string) (models.Concept, error, int)

func (*Client) GetDeviceClass

func (c *Client) GetDeviceClass(id string) (result models.DeviceClass, err error, errCode int)

func (*Client) GetDeviceClasses

func (c *Client) GetDeviceClasses() ([]models.DeviceClass, error, int)

func (*Client) GetDeviceClassesControllingFunctions

func (c *Client) GetDeviceClassesControllingFunctions(id string) (result []models.Function, err error, errCode int)

func (*Client) GetDeviceClassesFunctions

func (c *Client) GetDeviceClassesFunctions(id string) (result []models.Function, err error, errCode int)

func (*Client) GetDeviceClassesWithControllingFunctions

func (c *Client) GetDeviceClassesWithControllingFunctions() ([]models.DeviceClass, error, int)

func (*Client) GetDeviceTypeSelectables

func (c *Client) GetDeviceTypeSelectables(query []model.FilterCriteria, pathPrefix string, interactionsFilter []string, includeModified bool) (result []model.DeviceTypeSelectable, err error, code int)

func (*Client) GetDeviceTypeSelectablesV2

func (c *Client) GetDeviceTypeSelectablesV2(query []model.FilterCriteria, pathPrefix string, includeModified bool, servicesMustMatchAllCriteria bool) (result []model.DeviceTypeSelectable, err error, code int)

func (*Client) GetFunction

func (c *Client) GetFunction(id string) (result models.Function, err error, errCode int)

func (*Client) GetFunctionsByType

func (c *Client) GetFunctionsByType(rdfType string) (result []models.Function, err error, errCode int)

func (*Client) GetLeafCharacteristics

func (c *Client) GetLeafCharacteristics() (result []models.Characteristic, err error, errCode int)

func (*Client) GetLocation

func (c *Client) GetLocation(id string, token string) (location models.Location, err error, errCode int)

func (*Client) GetService

func (c *Client) GetService(id string) (result models.Service, err error, code int)

func (*Client) GetUsedInDeviceType

func (c *Client) GetUsedInDeviceType(query model.UsedInDeviceTypeQuery) (result model.UsedInDeviceTypeResponse, err error, errCode int)

func (*Client) ListDeviceTypes

func (c *Client) ListDeviceTypes(token string, limit int64, offset int64, sort string, filter []model.FilterCriteria, interactionsFilter []string, includeModified bool, includeUnmodified bool) (result []models.DeviceType, err error, errCode int)

func (*Client) ListDeviceTypesV2

func (c *Client) ListDeviceTypesV2(token string, limit int64, offset int64, sort string, filter []model.FilterCriteria, includeModified bool, includeUnmodified bool) (result []models.DeviceType, err error, errCode int)

func (*Client) ListHubDeviceIds

func (c *Client) ListHubDeviceIds(id string, token string, action model.AuthAction, asLocalId bool) (result []string, err error, errCode int)

func (*Client) ListProtocols

func (c *Client) ListProtocols(token string, limit int64, offset int64, sort string) (result []models.Protocol, err error, errCode int)

func (*Client) ReadDevice

func (c *Client) ReadDevice(id string, token string, action model.AuthAction) (result models.Device, err error, errCode int)

func (*Client) ReadDeviceByLocalId

func (c *Client) ReadDeviceByLocalId(localId string, token string, action model.AuthAction) (result models.Device, err error, errCode int)

func (*Client) ReadDeviceGroup

func (c *Client) ReadDeviceGroup(id string, token string, filterGenericDuplicateCriteria bool) (result models.DeviceGroup, err error, errCode int)

func (*Client) ReadDeviceType

func (c *Client) ReadDeviceType(id string, token string) (result models.DeviceType, err error, errCode int)

func (*Client) ReadHub

func (c *Client) ReadHub(id string, token string, action model.AuthAction) (result models.Hub, err error, errCode int)

func (*Client) ReadProtocol

func (c *Client) ReadProtocol(id string, token string) (result models.Protocol, err error, errCode int)

func (*Client) ValidateAspect

func (c *Client) ValidateAspect(aspect models.Aspect) (err error, code int)

func (*Client) ValidateAspectDelete

func (c *Client) ValidateAspectDelete(id string) (err error, code int)

func (*Client) ValidateCharacteristicDelete

func (c *Client) ValidateCharacteristicDelete(id string) (err error, code int)

func (*Client) ValidateCharacteristics

func (c *Client) ValidateCharacteristics(characteristic models.Characteristic) (err error, code int)

func (*Client) ValidateConcept

func (c *Client) ValidateConcept(concept models.Concept) (err error, code int)

func (*Client) ValidateConceptDelete

func (c *Client) ValidateConceptDelete(id string) (err error, code int)

func (*Client) ValidateDevice

func (c *Client) ValidateDevice(device models.Device) (err error, code int)

func (*Client) ValidateDeviceClass

func (c *Client) ValidateDeviceClass(deviceclass models.DeviceClass) (err error, code int)

func (*Client) ValidateDeviceClassDelete

func (c *Client) ValidateDeviceClassDelete(id string) (err error, code int)

func (*Client) ValidateDeviceGroup

func (c *Client) ValidateDeviceGroup(deviceGroup models.DeviceGroup) (err error, code int)

func (*Client) ValidateDeviceType

func (c *Client) ValidateDeviceType(deviceType models.DeviceType, options model.ValidationOptions) (err error, code int)

func (*Client) ValidateFunction

func (c *Client) ValidateFunction(function models.Function) (err error, code int)

func (*Client) ValidateFunctionDelete

func (c *Client) ValidateFunctionDelete(id string) (err error, code int)

func (*Client) ValidateHub

func (c *Client) ValidateHub(hub models.Hub) (err error, code int)

func (*Client) ValidateLocation

func (c *Client) ValidateLocation(location models.Location) (err error, code int)

func (*Client) ValidateProtocol

func (c *Client) ValidateProtocol(protocol models.Protocol) (err error, code int)

type DeviceTypeValidationOptions

type DeviceTypeValidationOptions = model.ValidationOptions

type Interface

type Interface = api.Controller

func NewClient

func NewClient(baseUrl string) Interface

func NewTestClient

func NewTestClient() (ctrl Interface, db database.Database, sec *mocks.Security, err error)