endpoint

package
v0.13.2 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2024 License: GPL-3.0 Imports: 41 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// AdminId ...
	AdminId = 1
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionEndpoint added in v0.12.0 

type ActionEndpoint struct {
	*CommonEndpoint
}

ActionEndpoint ...

func NewActionEndpoint added in v0.12.0 

func NewActionEndpoint(common *CommonEndpoint) *ActionEndpoint

NewActionEndpoint ...

func (*ActionEndpoint) Add added in v0.12.0 

func (n *ActionEndpoint) Add(ctx context.Context, action *m.Action) (result *m.Action, err error)

Add ...

func (*ActionEndpoint) Delete added in v0.12.0 

func (n *ActionEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*ActionEndpoint) GetById added in v0.12.0 

func (n *ActionEndpoint) GetById(ctx context.Context, id int64) (result *m.Action, err error)

GetById ...

func (*ActionEndpoint) GetList added in v0.12.0 

func (n *ActionEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.Action, total int64, err error)

GetList ...

func (*ActionEndpoint) Search added in v0.12.0 

func (n *ActionEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Action, total int64, err error)

Search ...

func (*ActionEndpoint) Update added in v0.12.0 

func (n *ActionEndpoint) Update(ctx context.Context, params *m.Action) (action *m.Action, err error)

Update ...

type AlexaSkillEndpoint added in v0.3.0 

type AlexaSkillEndpoint struct {
	*CommonEndpoint
}

AlexaSkillEndpoint ...

func NewAlexaSkillEndpoint added in v0.3.0 

func NewAlexaSkillEndpoint(common *CommonEndpoint) *AlexaSkillEndpoint

NewAlexaSkillEndpoint ...

func (*AlexaSkillEndpoint) Add added in v0.3.0 

func (n *AlexaSkillEndpoint) Add(ctx context.Context, params *m.AlexaSkill) (result *m.AlexaSkill, err error)

Add ...

func (*AlexaSkillEndpoint) Delete added in v0.3.0 

func (n *AlexaSkillEndpoint) Delete(ctx context.Context, skillId int64) (err error)

Delete ...

func (*AlexaSkillEndpoint) GetById added in v0.3.0 

func (n *AlexaSkillEndpoint) GetById(ctx context.Context, appId int64) (result *m.AlexaSkill, err error)

GetById ...

func (*AlexaSkillEndpoint) GetList added in v0.3.0 

func (n *AlexaSkillEndpoint) GetList(ctx context.Context, limit, offset int64, order, sortBy string) (result []*m.AlexaSkill, total int64, err error)

GetList ...

func (*AlexaSkillEndpoint) Update added in v0.3.0 

func (n *AlexaSkillEndpoint) Update(ctx context.Context, params *m.AlexaSkill) (skill *m.AlexaSkill, err error)

Update ...

type AreaEndpoint added in v0.5.2 

type AreaEndpoint struct {
	*CommonEndpoint
}

AreaEndpoint ...

func NewAreaEndpoint added in v0.5.2 

func NewAreaEndpoint(common *CommonEndpoint) *AreaEndpoint

NewAreaEndpoint ...

func (*AreaEndpoint) Add added in v0.5.2 

func (n *AreaEndpoint) Add(ctx context.Context, params *m.Area) (result *m.Area, err error)

Add ...

func (*AreaEndpoint) Delete added in v0.5.2 

func (n *AreaEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*AreaEndpoint) GetById added in v0.5.2 

func (n *AreaEndpoint) GetById(ctx context.Context, id int64) (result *m.Area, err error)

GetById ...

func (*AreaEndpoint) GetByName added in v0.5.2 

func (n *AreaEndpoint) GetByName(ctx context.Context, name string) (result *m.Area, err error)

GetByName ...

func (*AreaEndpoint) GetList added in v0.5.2 

func (n *AreaEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.Area, total int64, err error)

GetList ...

func (*AreaEndpoint) Search added in v0.5.2 

func (n *AreaEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Area, total int64, err error)

Search ...

func (*AreaEndpoint) Update added in v0.5.2 

func (n *AreaEndpoint) Update(ctx context.Context, params *m.Area) (area *m.Area, err error)

Update ...

type AuthEndpoint 

type AuthEndpoint struct {
	*CommonEndpoint
}

AuthEndpoint ...

func NewAuthEndpoint 

func NewAuthEndpoint(common *CommonEndpoint) *AuthEndpoint

NewAuthEndpoint ...

func (*AuthEndpoint) AccessList 

func (a *AuthEndpoint) AccessList(ctx context.Context, user *m.User, accessListService access_list.AccessListService) (accessList *access_list.AccessList, err error)

AccessList ...

func (*AuthEndpoint) PasswordReset added in v0.11.2 

func (a *AuthEndpoint) PasswordReset(ctx context.Context, userEmail string, token, newPassword *string) (err error)

PasswordReset ...

func (*AuthEndpoint) SignIn 

func (a *AuthEndpoint) SignIn(ctx context.Context, email, password string, ip string) (user *m.User, accessToken string, err error)

SignIn ...

func (*AuthEndpoint) SignOut 

func (a *AuthEndpoint) SignOut(ctx context.Context, user *m.User) (err error)

SignOut ...

type BackupEndpoint added in v0.7.1 

type BackupEndpoint struct {
	*CommonEndpoint
	// contains filtered or unexported fields
}

BackupEndpoint ...

func NewBackupEndpoint added in v0.7.1 

func NewBackupEndpoint(common *CommonEndpoint, backup *backup.Backup) *BackupEndpoint

NewBackupEndpoint ...

func (*BackupEndpoint) ApplyChanges added in v0.12.0 

func (b *BackupEndpoint) ApplyChanges(ctx context.Context) (err error)

func (*BackupEndpoint) Delete added in v0.12.0 

func (b *BackupEndpoint) Delete(ctx context.Context, name string) (err error)

func (*BackupEndpoint) GetList added in v0.7.1 

func (b *BackupEndpoint) GetList(ctx context.Context, pagination common.PageParams) (items []*m.Backup, total int64, err error)

GetList ...

func (*BackupEndpoint) New added in v0.7.1 

func (b *BackupEndpoint) New(ctx context.Context) (err error)

New ...

func (*BackupEndpoint) Restore added in v0.7.1 

func (b *BackupEndpoint) Restore(ctx context.Context, name string) (err error)

Restore ...

func (*BackupEndpoint) RollbackChanges added in v0.12.0 

func (b *BackupEndpoint) RollbackChanges(ctx context.Context) (err error)

func (*BackupEndpoint) Upload added in v0.12.0 

func (b *BackupEndpoint) Upload(ctx context.Context, files map[string][]*multipart.FileHeader) (fileList []*m.Backup, errs []error)

Upload ...

type CommonEndpoint 

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

CommonEndpoint ...

func NewCommonEndpoint 

func NewCommonEndpoint(adaptors *adaptors.Adaptors,
	accessList access_list.AccessListService,
	scriptService scripts.ScriptService,
	zigbee2mqtt zigbee2mqtt.Zigbee2mqtt,
	eventBus bus.Bus,
	supervisor supervisor.Supervisor,
	mqtt mqtt.MqttServ,
	jwtManager jwt_manager.JwtManager,
	validation *validation.Validate,
	appConfig *m.AppConfig,
	automation automation.Automation,
) *CommonEndpoint

NewCommonEndpoint ...

type ConditionEndpoint added in v0.12.0 

type ConditionEndpoint struct {
	*CommonEndpoint
}

ConditionEndpoint ...

func NewConditionEndpoint added in v0.12.0 

func NewConditionEndpoint(common *CommonEndpoint) *ConditionEndpoint

NewConditionEndpoint ...

func (*ConditionEndpoint) Add added in v0.12.0 

func (n *ConditionEndpoint) Add(ctx context.Context, condition *m.Condition) (result *m.Condition, err error)

Add ...

func (*ConditionEndpoint) Delete added in v0.12.0 

func (n *ConditionEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*ConditionEndpoint) GetById added in v0.12.0 

func (n *ConditionEndpoint) GetById(ctx context.Context, id int64) (result *m.Condition, err error)

GetById ...

func (*ConditionEndpoint) GetList added in v0.12.0 

func (n *ConditionEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.Condition, total int64, err error)

GetList ...

func (*ConditionEndpoint) Search added in v0.12.0 

func (n *ConditionEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Condition, total int64, err error)

Search ...

func (*ConditionEndpoint) Update added in v0.12.0 

func (n *ConditionEndpoint) Update(ctx context.Context, params *m.Condition) (result *m.Condition, err error)

Update ...

type DashboardCardEndpoint added in v0.6.0 

type DashboardCardEndpoint struct {
	*CommonEndpoint
}

DashboardCardEndpoint ...

func NewDashboardCardEndpoint added in v0.6.0 

func NewDashboardCardEndpoint(common *CommonEndpoint) *DashboardCardEndpoint

NewDashboardCardEndpoint ...

func (*DashboardCardEndpoint) Add added in v0.6.0 

func (c *DashboardCardEndpoint) Add(ctx context.Context, card *m.DashboardCard) (result *m.DashboardCard, err error)

Add ...

func (*DashboardCardEndpoint) Delete added in v0.6.0 

func (c *DashboardCardEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*DashboardCardEndpoint) GetById added in v0.6.0 

func (c *DashboardCardEndpoint) GetById(ctx context.Context, id int64) (card *m.DashboardCard, err error)

GetById ...

func (*DashboardCardEndpoint) GetList added in v0.6.0 

func (c *DashboardCardEndpoint) GetList(ctx context.Context, pagination common.PageParams) (list []*m.DashboardCard, total int64, err error)

GetList ...

func (*DashboardCardEndpoint) Import added in v0.6.0 

func (c *DashboardCardEndpoint) Import(ctx context.Context, card *m.DashboardCard) (result *m.DashboardCard, err error)

Import ...

func (*DashboardCardEndpoint) Update added in v0.6.0 

func (i *DashboardCardEndpoint) Update(ctx context.Context, params *m.DashboardCard) (result *m.DashboardCard, err error)

Update ...

type DashboardCardItemEndpoint added in v0.6.0 

type DashboardCardItemEndpoint struct {
	*CommonEndpoint
}

DashboardCardItemEndpoint ...

func NewDashboardCardItemEndpoint added in v0.6.0 

func NewDashboardCardItemEndpoint(common *CommonEndpoint) *DashboardCardItemEndpoint

NewDashboardCardItemEndpoint ...

func (*DashboardCardItemEndpoint) Add added in v0.6.0 

func (c *DashboardCardItemEndpoint) Add(ctx context.Context, cardItem *m.DashboardCardItem) (result *m.DashboardCardItem, err error)

Add ...

func (*DashboardCardItemEndpoint) Delete added in v0.6.0 

func (c *DashboardCardItemEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*DashboardCardItemEndpoint) GetById added in v0.6.0 

func (c *DashboardCardItemEndpoint) GetById(ctx context.Context, id int64) (card *m.DashboardCardItem, err error)

GetById ...

func (*DashboardCardItemEndpoint) GetList added in v0.6.0 

func (c *DashboardCardItemEndpoint) GetList(ctx context.Context, pagination common.PageParams) (list []*m.DashboardCardItem, total int64, err error)

GetList ...

func (*DashboardCardItemEndpoint) Update added in v0.6.0 

func (c *DashboardCardItemEndpoint) Update(ctx context.Context, params *m.DashboardCardItem) (result *m.DashboardCardItem, err error)

Update ...

type DashboardEndpoint added in v0.6.0 

type DashboardEndpoint struct {
	*CommonEndpoint
}

DashboardEndpoint ...

func NewDashboardEndpoint added in v0.6.0 

func NewDashboardEndpoint(common *CommonEndpoint) *DashboardEndpoint

NewDashboardEndpoint ...

func (*DashboardEndpoint) Add added in v0.6.0 

func (d *DashboardEndpoint) Add(ctx context.Context, board *m.Dashboard) (result *m.Dashboard, err error)

Add ...

func (*DashboardEndpoint) Delete added in v0.6.0 

func (d *DashboardEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*DashboardEndpoint) GetById added in v0.6.0 

func (d *DashboardEndpoint) GetById(ctx context.Context, id int64) (board *m.Dashboard, err error)

GetById ...

func (*DashboardEndpoint) GetList added in v0.6.0 

func (d *DashboardEndpoint) GetList(ctx context.Context, pagination common.PageParams) (list []*m.Dashboard, total int64, err error)

GetList ...

func (*DashboardEndpoint) Import added in v0.6.0 

func (d *DashboardEndpoint) Import(ctx context.Context, board *m.Dashboard) (result *m.Dashboard, err error)

Import ...

func (*DashboardEndpoint) Search added in v0.7.0 

func (d *DashboardEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Dashboard, total int64, err error)

Search ...

func (*DashboardEndpoint) Update added in v0.6.0 

func (i *DashboardEndpoint) Update(ctx context.Context, params *m.Dashboard) (result *m.Dashboard, err error)

Update ...

type DashboardTabEndpoint added in v0.6.0 

type DashboardTabEndpoint struct {
	*CommonEndpoint
}

DashboardTabEndpoint ...

func NewDashboardTabEndpoint added in v0.6.0 

func NewDashboardTabEndpoint(common *CommonEndpoint) *DashboardTabEndpoint

NewDashboardTabEndpoint ...

func (*DashboardTabEndpoint) Add added in v0.6.0 

func (t *DashboardTabEndpoint) Add(ctx context.Context, tab *m.DashboardTab) (result *m.DashboardTab, err error)

Add ...

func (*DashboardTabEndpoint) Delete added in v0.6.0 

func (t *DashboardTabEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*DashboardTabEndpoint) GetById added in v0.6.0 

func (t *DashboardTabEndpoint) GetById(ctx context.Context, id int64) (tab *m.DashboardTab, err error)

GetById ...

func (*DashboardTabEndpoint) GetList added in v0.6.0 

func (t *DashboardTabEndpoint) GetList(ctx context.Context, pagination common.PageParams) (list []*m.DashboardTab, total int64, err error)

GetList ...

func (*DashboardTabEndpoint) Update added in v0.6.0 

func (t *DashboardTabEndpoint) Update(ctx context.Context, params *m.DashboardTab) (result *m.DashboardTab, err error)

Update ...

type DeveloperToolsEndpoint added in v0.5.0 

type DeveloperToolsEndpoint struct {
	*CommonEndpoint
}

DeveloperToolsEndpoint ...

func NewDeveloperToolsEndpoint added in v0.5.0 

func NewDeveloperToolsEndpoint(common *CommonEndpoint) *DeveloperToolsEndpoint

NewDeveloperToolsEndpoint ...

func (DeveloperToolsEndpoint) EntitySetState added in v0.5.3 

func (d DeveloperToolsEndpoint) EntitySetState(ctx context.Context, entityId string, newState *string, attrs map[string]interface{}) (err error)

EntitySetState ...

func (*DeveloperToolsEndpoint) EntitySetStateName added in v0.12.0 

func (d *DeveloperToolsEndpoint) EntitySetStateName(ctx context.Context, id common.EntityId, name string) (err error)

EntitySetStateName ...

func (*DeveloperToolsEndpoint) GetEventBusState added in v0.12.0 

func (d *DeveloperToolsEndpoint) GetEventBusState(ctx context.Context, pagination common.PageParams) (bus.Stats, int64, error)

GetEventBusState ...

func (*DeveloperToolsEndpoint) ReloadEntity added in v0.5.3 

func (d *DeveloperToolsEndpoint) ReloadEntity(ctx context.Context, id common.EntityId) (err error)

ReloadEntity ...

func (DeveloperToolsEndpoint) StateList added in v0.5.0 

func (d DeveloperToolsEndpoint) StateList(ctx context.Context) (states []m.EntityShort, total int64, err error)

StateList ...

func (*DeveloperToolsEndpoint) TaskCallAction added in v0.5.3 

func (d *DeveloperToolsEndpoint) TaskCallAction(ctx context.Context, id int64, name string) (err error)

TaskCallAction ...

func (*DeveloperToolsEndpoint) TaskCallTrigger added in v0.5.3 

func (d *DeveloperToolsEndpoint) TaskCallTrigger(ctx context.Context, id int64, name string) (err error)

TaskCallTrigger ...

type Endpoint 

type Endpoint struct {
	AlexaSkill        *AlexaSkillEndpoint
	Auth              *AuthEndpoint
	Image             *ImageEndpoint
	Log               *LogEndpoint
	Role              *RoleEndpoint
	Script            *ScriptEndpoint
	User              *UserEndpoint
	Template          *TemplateEndpoint
	Notify            *NotifyEndpoint
	MessageDelivery   *MessageDeliveryEndpoint
	Version           *VersionEndpoint
	Zigbee2mqtt       *Zigbee2mqttEndpoint
	Entity            *EntityEndpoint
	DeveloperTools    *DeveloperToolsEndpoint
	Mqtt              *MqttEndpoint
	Plugin            *PluginEndpoint
	PluginActor       *PluginActorEndpoint
	Action            *ActionEndpoint
	Condition         *ConditionEndpoint
	Trigger           *TriggerEndpoint
	Task              *TaskEndpoint
	Area              *AreaEndpoint
	Interact          *InteractEndpoint
	Dashboard         *DashboardEndpoint
	DashboardTab      *DashboardTabEndpoint
	DashboardCard     *DashboardCardEndpoint
	DashboardCardItem *DashboardCardItemEndpoint
	Variable          *VariableEndpoint
	EntityStorage     *EntityStorageEndpoint
	Metric            *MetricEndpoint
	Backup            *BackupEndpoint
	Stream            *StreamEndpoint
}

Endpoint ...

func NewEndpoint 

func NewEndpoint(backup *backup.Backup, stream *stream.Stream, common *CommonEndpoint) *Endpoint

NewEndpoint ...

type EntityEndpoint added in v0.5.0 

type EntityEndpoint struct {
	*CommonEndpoint
}

EntityEndpoint ...

func NewEntityEndpoint added in v0.5.0 

func NewEntityEndpoint(common *CommonEndpoint) *EntityEndpoint

NewEntityEndpoint ...

func (*EntityEndpoint) Add added in v0.5.0 

func (n *EntityEndpoint) Add(ctx context.Context, entity *m.Entity) (result *m.Entity, err error)

Add ...

func (*EntityEndpoint) Delete added in v0.5.0 

func (n *EntityEndpoint) Delete(ctx context.Context, id common.EntityId) (err error)

Delete ...

func (*EntityEndpoint) Disable added in v0.12.0 

func (n *EntityEndpoint) Disable(ctx context.Context, id common.EntityId) (err error)

Disable ...

func (*EntityEndpoint) Enable added in v0.12.0 

func (n *EntityEndpoint) Enable(ctx context.Context, id common.EntityId) (err error)

Enable ...

func (*EntityEndpoint) GetById added in v0.5.0 

func (n *EntityEndpoint) GetById(ctx context.Context, id common.EntityId) (result *m.Entity, err error)

GetById ...

func (*EntityEndpoint) Import added in v0.7.2 

func (n *EntityEndpoint) Import(ctx context.Context, entity *m.Entity) (err error)

Import ...

func (*EntityEndpoint) List added in v0.5.0 

func (n *EntityEndpoint) List(ctx context.Context, pagination common.PageParams, query, plugin *string, areaId *int64) (entities []*m.Entity, total int64, err error)

List ...

func (*EntityEndpoint) Search added in v0.5.0 

func (n *EntityEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Entity, total int64, err error)

Search ...

func (*EntityEndpoint) Update added in v0.5.0 

func (n *EntityEndpoint) Update(ctx context.Context, params *m.Entity) (result *m.Entity, err error)

Update ...

type EntityStorageEndpoint added in v0.6.0 

type EntityStorageEndpoint struct {
	*CommonEndpoint
}

EntityStorageEndpoint ...

func NewEntityStorageEndpoint added in v0.6.0 

func NewEntityStorageEndpoint(common *CommonEndpoint) *EntityStorageEndpoint

NewEntityStorageEndpoint ...

func (*EntityStorageEndpoint) GetList added in v0.6.0 

func (i *EntityStorageEndpoint) GetList(ctx context.Context, entityIds []common.EntityId, pagination common.PageParams,
	startDate, endDate *time.Time) (result *m.EntityStorageList, total int64, err error)

GetList ...

type ImageEndpoint 

type ImageEndpoint struct {
	*CommonEndpoint
}

ImageEndpoint ...

func NewImageEndpoint 

func NewImageEndpoint(common *CommonEndpoint) *ImageEndpoint

NewImageEndpoint ...

func (*ImageEndpoint) Add 

func (i *ImageEndpoint) Add(ctx context.Context, params *m.Image) (image *m.Image, err error)

Add ...

func (*ImageEndpoint) Delete 

func (i *ImageEndpoint) Delete(ctx context.Context, imageId int64) (err error)

Delete ...

func (*ImageEndpoint) GetById 

func (i *ImageEndpoint) GetById(ctx context.Context, imageId int64) (image *m.Image, err error)

GetById ...

func (*ImageEndpoint) GetFilterList added in v0.5.2 

func (i *ImageEndpoint) GetFilterList(ctx context.Context) (filterList []*m.ImageFilterList, err error)

GetFilterList ...

func (*ImageEndpoint) GetList 

func (i *ImageEndpoint) GetList(ctx context.Context, pagination common.PageParams) (items []*m.Image, total int64, err error)

GetList ...

func (*ImageEndpoint) GetListByDate added in v0.5.3 

func (i *ImageEndpoint) GetListByDate(ctx context.Context, filter string) (images []*m.Image, err error)

GetListByDate ...

func (*ImageEndpoint) Update 

func (i *ImageEndpoint) Update(ctx context.Context, params *m.Image) (result *m.Image, err error)

Update ...

func (*ImageEndpoint) Upload 

func (i *ImageEndpoint) Upload(ctx context.Context, files map[string][]*multipart.FileHeader) (fileList []*m.Image, errs []error)

Upload ...

type InteractEndpoint added in v0.5.3 

type InteractEndpoint struct {
	*CommonEndpoint
}

InteractEndpoint ...

func NewInteractEndpoint added in v0.5.3 

func NewInteractEndpoint(common *CommonEndpoint) *InteractEndpoint

NewInteractEndpoint ...

func (InteractEndpoint) EntityCallAction added in v0.5.3 

func (d InteractEndpoint) EntityCallAction(ctx context.Context, entityId string, action string, args map[string]interface{}) (err error)

EntityCallAction ...

type LogEndpoint 

type LogEndpoint struct {
	*CommonEndpoint
}

LogEndpoint ...

func NewLogEndpoint 

func NewLogEndpoint(common *CommonEndpoint) *LogEndpoint

NewLogEndpoint ...

func (*LogEndpoint) Add 

func (l *LogEndpoint) Add(ctx context.Context, log *m.Log) (result *m.Log, err error)

Add ...

func (*LogEndpoint) Delete 

func (l *LogEndpoint) Delete(ctx context.Context, logId int64) (err error)

Delete ...

func (*LogEndpoint) GetById 

func (l *LogEndpoint) GetById(ctx context.Context, id int64) (log *m.Log, err error)

GetById ...

func (*LogEndpoint) GetList 

func (l *LogEndpoint) GetList(ctx context.Context, pagination common.PageParams, query *string, startDate, endDate *time.Time) (list []*m.Log, total int64, err error)

GetList ...

func (*LogEndpoint) Search 

func (l *LogEndpoint) Search(ctx context.Context, query string, limit, offset int) (list []*m.Log, total int64, err error)

Search ...

type MessageDeliveryEndpoint added in v0.0.17 

type MessageDeliveryEndpoint struct {
	*CommonEndpoint
}

MessageDeliveryEndpoint ...

func NewMessageDeliveryEndpoint added in v0.0.17 

func NewMessageDeliveryEndpoint(common *CommonEndpoint) *MessageDeliveryEndpoint

NewMessageDeliveryEndpoint ...

func (*MessageDeliveryEndpoint) Delete added in v0.0.17 

func (n *MessageDeliveryEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*MessageDeliveryEndpoint) List added in v0.10.0 

func (n *MessageDeliveryEndpoint) List(ctx context.Context, pagination common.PageParams, query *string, startDate, endDate *time.Time) (result []*m.MessageDelivery, total int64, err error)

List ...

type MetricEndpoint added in v0.7.0 

type MetricEndpoint struct {
	*CommonEndpoint
}

MetricEndpoint ...

func NewMetricEndpoint added in v0.7.0 

func NewMetricEndpoint(common *CommonEndpoint) *MetricEndpoint

NewMetricEndpoint ...

func (*MetricEndpoint) GetByIdWithData added in v0.7.0 

func (l *MetricEndpoint) GetByIdWithData(ctx context.Context, from, to *time.Time, metricId int64, _metricRange *string) (metric *m.Metric, err error)

GetByIdWithData ...

type MqttEndpoint added in v0.0.20 

type MqttEndpoint struct {
	*CommonEndpoint
}

MqttEndpoint ...

func NewMqttEndpoint added in v0.0.20 

func NewMqttEndpoint(common *CommonEndpoint) *MqttEndpoint

NewMqttEndpoint ...

func (*MqttEndpoint) CloseClient added in v0.0.20 

func (m *MqttEndpoint) CloseClient(clientId string) (err error)

CloseClient ...

func (*MqttEndpoint) GetClientById added in v0.12.0 

func (m *MqttEndpoint) GetClientById(ctx context.Context, clientId string) (client *admin.ClientInfo, err error)

GetClientById ...

func (*MqttEndpoint) GetClientList added in v0.12.0 

func (m *MqttEndpoint) GetClientList(ctx context.Context, pagination common.PageParams) (list []*admin.ClientInfo, total uint32, err error)

GetClientList ...

func (*MqttEndpoint) GetSession added in v0.0.20 

func (m *MqttEndpoint) GetSession(clientId string) (session *admin.SessionInfo, err error)

GetSession ...

func (*MqttEndpoint) GetSessions added in v0.0.20 

func (m *MqttEndpoint) GetSessions(limit, offset uint) (list []*admin.SessionInfo, total int, err error)

GetSessions ...

func (*MqttEndpoint) GetSubscriptionList added in v0.12.0 

func (m *MqttEndpoint) GetSubscriptionList(ctx context.Context, clientId *string, pagination common.PageParams) (list []*admin.SubscriptionInfo, total int, err error)

GetSubscriptionList ...

func (*MqttEndpoint) Publish added in v0.0.20 

func (m *MqttEndpoint) Publish(topic string, qos int, payload []byte, retain bool) (err error)

Publish ...

func (*MqttEndpoint) SearchTopic added in v0.0.21 

func (m *MqttEndpoint) SearchTopic(query string, limit, offset int) (result []*admin.SubscriptionInfo, total int64, err error)

SearchTopic ...

func (*MqttEndpoint) Subscribe added in v0.0.20 

func (m *MqttEndpoint) Subscribe(clientId, topic string, qos int) (err error)

Subscribe ...

func (*MqttEndpoint) Unsubscribe added in v0.0.20 

func (m *MqttEndpoint) Unsubscribe(clientId, topic string) (err error)

Unsubscribe ...

type NotifyEndpoint added in v0.0.17 

type NotifyEndpoint struct {
	*CommonEndpoint
}

NotifyEndpoint ...

func NewNotifyEndpoint added in v0.0.17 

func NewNotifyEndpoint(common *CommonEndpoint) *NotifyEndpoint

NewNotifyEndpoint ...

func (*NotifyEndpoint) Repeat added in v0.0.17 

func (n *NotifyEndpoint) Repeat(ctx context.Context, id int64) (err error)

Repeat ...

func (*NotifyEndpoint) Send added in v0.0.17 

func (n *NotifyEndpoint) Send(ctx context.Context, params *m.NewNotifrMessage) (err error)

Send ...

type PluginActorEndpoint added in v0.5.0 

type PluginActorEndpoint struct {
	*CommonEndpoint
}

PluginActorEndpoint ...

func NewPluginActorEndpoint added in v0.5.0 

func NewPluginActorEndpoint(common *CommonEndpoint) *PluginActorEndpoint

NewPluginActorEndpoint ...

func (*PluginActorEndpoint) Add added in v0.5.0 

func (p *PluginActorEndpoint) Add()

Add ...

func (*PluginActorEndpoint) Delete added in v0.5.0 

func (p *PluginActorEndpoint) Delete()

Delete ...

func (*PluginActorEndpoint) GetByName added in v0.5.0 

func (p *PluginActorEndpoint) GetByName(name string)

GetByName ...

func (*PluginActorEndpoint) Search added in v0.5.0 

func (p *PluginActorEndpoint) Search(query string, limit, offset int)

Search ...

func (*PluginActorEndpoint) Update added in v0.5.0 

func (p *PluginActorEndpoint) Update()

Update ...

type PluginEndpoint added in v0.5.0 

type PluginEndpoint struct {
	*CommonEndpoint
}

PluginEndpoint ...

func NewPluginEndpoint added in v0.5.0 

func NewPluginEndpoint(common *CommonEndpoint) *PluginEndpoint

NewPluginEndpoint ...

func (*PluginEndpoint) Disable added in v0.5.0 

func (p *PluginEndpoint) Disable(ctx context.Context, pluginName string) (err error)

Disable ...

func (*PluginEndpoint) Enable added in v0.5.1 

func (p *PluginEndpoint) Enable(ctx context.Context, pluginName string) (err error)

Enable ...

func (*PluginEndpoint) GetByName added in v0.10.2 

func (p *PluginEndpoint) GetByName(ctx context.Context, pluginName string) (plugin *m.Plugin, err error)

GetByName ...

func (*PluginEndpoint) GetList added in v0.5.0 

func (p *PluginEndpoint) GetList(ctx context.Context, pagination common.PageParams) (plugins []*m.Plugin, total int64, err error)

GetList ...

func (*PluginEndpoint) GetOptions added in v0.5.0 

func (p *PluginEndpoint) GetOptions(ctx context.Context, pluginName string) (options m.PluginOptions, err error)

GetOptions ...

func (*PluginEndpoint) Search added in v0.5.2 

func (n *PluginEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Plugin, total int64, err error)

Search ...

func (*PluginEndpoint) UpdateSettings added in v0.10.2 

func (n *PluginEndpoint) UpdateSettings(ctx context.Context, name string, settings m.Attributes) (err error)

UpdateSettings ...

type RoleEndpoint 

type RoleEndpoint struct {
	*CommonEndpoint
}

RoleEndpoint ...

func NewRoleEndpoint 

func NewRoleEndpoint(common *CommonEndpoint) *RoleEndpoint

NewRoleEndpoint ...

func (*RoleEndpoint) Add 

func (n *RoleEndpoint) Add(ctx context.Context, params *m.Role) (result *m.Role, err error)

Add ...

func (*RoleEndpoint) Delete 

func (n *RoleEndpoint) Delete(ctx context.Context, name string) (err error)

Delete ...

func (*RoleEndpoint) GetAccessList 

func (n *RoleEndpoint) GetAccessList(ctx context.Context, roleName string,
	accessListService access_list.AccessListService) (accessList access_list.AccessList, err error)

GetAccessList ...

func (*RoleEndpoint) GetByName 

func (n *RoleEndpoint) GetByName(ctx context.Context, name string) (result *m.Role, err error)

GetByName ...

func (*RoleEndpoint) GetList 

func (n *RoleEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.Role, total int64, err error)

GetList ...

func (*RoleEndpoint) Search 

func (n *RoleEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Role, total int64, err error)

Search ...

func (*RoleEndpoint) Update 

func (n *RoleEndpoint) Update(ctx context.Context, params *m.Role) (result *m.Role, err error)

Update ...

func (*RoleEndpoint) UpdateAccessList 

func (n *RoleEndpoint) UpdateAccessList(ctx context.Context, roleName string, accessListDif map[string]map[string]bool) (err error)

UpdateAccessList ...

type ScriptEndpoint 

type ScriptEndpoint struct {
	*CommonEndpoint
}

ScriptEndpoint ...

func NewScriptEndpoint 

func NewScriptEndpoint(common *CommonEndpoint) *ScriptEndpoint

NewScriptEndpoint ...

func (*ScriptEndpoint) Add 

func (n *ScriptEndpoint) Add(ctx context.Context, params *m.Script) (script *m.Script, err error)

Add ...

func (*ScriptEndpoint) Copy added in v0.0.10 

func (n *ScriptEndpoint) Copy(ctx context.Context, scriptId int64) (script *m.Script, err error)

Copy ...

func (*ScriptEndpoint) DeleteScriptById 

func (n *ScriptEndpoint) DeleteScriptById(ctx context.Context, scriptId int64) (err error)

DeleteScriptById ...

func (*ScriptEndpoint) Execute 

func (n *ScriptEndpoint) Execute(ctx context.Context, scriptId int64) (result string, err error)

Execute ...

func (*ScriptEndpoint) ExecuteSource 

func (n *ScriptEndpoint) ExecuteSource(ctx context.Context, script *m.Script) (result string, err error)

ExecuteSource ...

func (*ScriptEndpoint) GetById 

func (n *ScriptEndpoint) GetById(ctx context.Context, scriptId int64) (result *m.Script, err error)

GetById ...

func (*ScriptEndpoint) GetList 

func (n *ScriptEndpoint) GetList(ctx context.Context, pagination common.PageParams, query *string) (result []*m.Script, total int64, err error)

GetList ...

func (*ScriptEndpoint) Search 

func (n *ScriptEndpoint) Search(ctx context.Context, query string, limit, offset int64) (devices []*m.Script, total int64, err error)

Search ...

func (*ScriptEndpoint) Statistic added in v0.12.0 

func (n *ScriptEndpoint) Statistic(ctx context.Context) (statistic []*m.Statistic, err error)

Statistic ...

func (*ScriptEndpoint) Update 

func (n *ScriptEndpoint) Update(ctx context.Context, params *m.Script) (result *m.Script, err error)

Update ...

type StreamEndpoint added in v0.9.5 

type StreamEndpoint struct {
	*CommonEndpoint
	// contains filtered or unexported fields
}

func NewStreamEndpoint added in v0.9.5 

func NewStreamEndpoint(common *CommonEndpoint, stream *stream.Stream) *StreamEndpoint

NewStreamEndpoint ...

func (*StreamEndpoint) Subscribe added in v0.9.5 

func (s *StreamEndpoint) Subscribe(ctx echo.Context, currentUser *m.User) error

type TaskEndpoint added in v0.5.1 

type TaskEndpoint struct {
	*CommonEndpoint
}

TaskEndpoint ...

func NewTaskEndpoint added in v0.5.1 

func NewTaskEndpoint(common *CommonEndpoint) *TaskEndpoint

NewTaskEndpoint ...

func (*TaskEndpoint) Add added in v0.5.1 

func (n *TaskEndpoint) Add(ctx context.Context, task *m.NewTask) (result *m.Task, err error)

Add ...

func (*TaskEndpoint) Delete added in v0.5.1 

func (n *TaskEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*TaskEndpoint) Disable added in v0.5.3 

func (n *TaskEndpoint) Disable(ctx context.Context, id int64) (err error)

Disable ...

func (*TaskEndpoint) Enable added in v0.5.3 

func (n *TaskEndpoint) Enable(ctx context.Context, id int64) (err error)

Enable ...

func (*TaskEndpoint) GetById added in v0.5.2 

func (n *TaskEndpoint) GetById(ctx context.Context, id int64) (task *m.Task, err error)

GetById ...

func (*TaskEndpoint) Import added in v0.11.0 

func (n *TaskEndpoint) Import(ctx context.Context, task *m.Task) (result *m.Task, err error)

Import ...

func (*TaskEndpoint) List added in v0.5.1 

func (n *TaskEndpoint) List(ctx context.Context, pagination common.PageParams) (tasks []*m.Task, total int64, err error)

List ...

func (*TaskEndpoint) Update added in v0.5.1 

func (n *TaskEndpoint) Update(ctx context.Context, task *m.UpdateTask) (result *m.Task, err error)

Update ...

type TemplateEndpoint added in v0.0.17 

type TemplateEndpoint struct {
	*CommonEndpoint
}

TemplateEndpoint ...

func NewTemplateEndpoint added in v0.0.17 

func NewTemplateEndpoint(common *CommonEndpoint) *TemplateEndpoint

NewTemplateEndpoint ...

func (*TemplateEndpoint) Delete added in v0.0.17 

func (t *TemplateEndpoint) Delete(ctx context.Context, name string) (err error)

Delete ...

func (*TemplateEndpoint) GetByName added in v0.0.17 

func (t *TemplateEndpoint) GetByName(ctx context.Context, name string) (result *m.Template, err error)

GetByName ...

func (*TemplateEndpoint) GetItemByName added in v0.0.17 

func (t *TemplateEndpoint) GetItemByName(ctx context.Context, name string) (result *m.Template, err error)

GetItemByName ...

func (*TemplateEndpoint) GetItemsSortedList added in v0.0.17 

func (t *TemplateEndpoint) GetItemsSortedList(ctx context.Context) (count int64, items []string, err error)

GetItemsSortedList ...

func (*TemplateEndpoint) GetItemsTree added in v0.0.17 

func (t *TemplateEndpoint) GetItemsTree(ctx context.Context) (tree []*m.TemplateTree, err error)

GetItemsTree ...

func (*TemplateEndpoint) GetList added in v0.0.17 

func (t *TemplateEndpoint) GetList(ctx context.Context) (count int64, templates []*m.Template, err error)

GetList ...

func (*TemplateEndpoint) Preview added in v0.0.17 

func (t *TemplateEndpoint) Preview(ctx context.Context, template *m.TemplateContent) (data string, err error)

Preview ...

func (*TemplateEndpoint) Search added in v0.0.17 

func (t *TemplateEndpoint) Search(ctx context.Context, query string, limit, offset int) (result []*m.Template, total int64, err error)

Search ...

func (*TemplateEndpoint) UpdateItemsTree added in v0.0.17 

func (t *TemplateEndpoint) UpdateItemsTree(ctx context.Context, tree []*m.TemplateTree) (err error)

UpdateItemsTree ...

func (*TemplateEndpoint) UpdateOrCreate added in v0.0.17 

func (t *TemplateEndpoint) UpdateOrCreate(ctx context.Context, params *m.Template) (err error)

UpdateOrCreate ...

func (*TemplateEndpoint) UpdateStatus added in v0.0.17 

func (t *TemplateEndpoint) UpdateStatus(ctx context.Context, params *m.Template) (err error)

UpdateStatus ...

type TriggerEndpoint added in v0.12.0 

type TriggerEndpoint struct {
	*CommonEndpoint
}

TriggerEndpoint ...

func NewTriggerEndpoint added in v0.12.0 

func NewTriggerEndpoint(common *CommonEndpoint) *TriggerEndpoint

NewTriggerEndpoint ...

func (*TriggerEndpoint) Add added in v0.12.0 

func (n *TriggerEndpoint) Add(ctx context.Context, params *m.NewTrigger) (result *m.Trigger, err error)

Add ...

func (*TriggerEndpoint) Delete added in v0.12.0 

func (n *TriggerEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*TriggerEndpoint) Disable added in v0.12.0 

func (n *TriggerEndpoint) Disable(ctx context.Context, id int64) (err error)

Disable ...

func (*TriggerEndpoint) Enable added in v0.12.0 

func (n *TriggerEndpoint) Enable(ctx context.Context, id int64) (err error)

Enable ...

func (*TriggerEndpoint) GetById added in v0.12.0 

func (n *TriggerEndpoint) GetById(ctx context.Context, id int64) (trigger *m.Trigger, err error)

GetById ...

func (*TriggerEndpoint) GetList added in v0.12.0 

func (n *TriggerEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.Trigger, total int64, err error)

GetList ...

func (*TriggerEndpoint) Search added in v0.12.0 

func (n *TriggerEndpoint) Search(ctx context.Context, query string, limit, offset int64) (result []*m.Trigger, total int64, err error)

Search ...

func (*TriggerEndpoint) Update added in v0.12.0 

func (n *TriggerEndpoint) Update(ctx context.Context, params *m.UpdateTrigger) (result *m.Trigger, err error)

Update ...

type UserEndpoint 

type UserEndpoint struct {
	*CommonEndpoint
}

UserEndpoint ...

func NewUserEndpoint 

func NewUserEndpoint(common *CommonEndpoint) *UserEndpoint

NewUserEndpoint ...

func (*UserEndpoint) Add 

func (n *UserEndpoint) Add(ctx context.Context, params *m.User,
	currentUser *m.User) (result *m.User, err error)

Add ...

func (*UserEndpoint) Delete 

func (n *UserEndpoint) Delete(ctx context.Context, userId int64) (err error)

Delete ...

func (*UserEndpoint) GetById 

func (n *UserEndpoint) GetById(ctx context.Context, userId int64) (result *m.User, err error)

GetById ...

func (*UserEndpoint) GetList 

func (n *UserEndpoint) GetList(ctx context.Context, pagination common.PageParams) (result []*m.User, total int64, err error)

GetList ...

func (*UserEndpoint) Update 

func (n *UserEndpoint) Update(ctx context.Context, params *m.User) (result *m.User, err error)

Update ...

func (*UserEndpoint) UpdateStatus 

func (n *UserEndpoint) UpdateStatus(ctx context.Context, userId int64, newStatus string) (err error)

UpdateStatus ...

type VariableEndpoint added in v0.6.0 

type VariableEndpoint struct {
	*CommonEndpoint
}

VariableEndpoint ...

func NewVariableEndpoint added in v0.6.0 

func NewVariableEndpoint(common *CommonEndpoint) *VariableEndpoint

NewVariableEndpoint ...

func (*VariableEndpoint) Add added in v0.6.0 

func (v *VariableEndpoint) Add(ctx context.Context, variable m.Variable) (err error)

Add ...

func (*VariableEndpoint) Delete added in v0.6.0 

func (v *VariableEndpoint) Delete(ctx context.Context, name string) (err error)

Delete ...

func (*VariableEndpoint) GetById added in v0.6.0 

func (v *VariableEndpoint) GetById(ctx context.Context, name string) (variable m.Variable, err error)

GetById ...

func (*VariableEndpoint) GetList added in v0.6.0 

func (v *VariableEndpoint) GetList(ctx context.Context, pagination common.PageParams) (list []m.Variable, total int64, err error)

GetList ...

func (*VariableEndpoint) Update added in v0.6.0 

func (v *VariableEndpoint) Update(ctx context.Context, variable m.Variable) (err error)

Update ...

type VersionEndpoint added in v0.0.24 

type VersionEndpoint struct {
	*CommonEndpoint
}

VersionEndpoint ...

func NewVersionEndpoint added in v0.0.24 

func NewVersionEndpoint(common *CommonEndpoint) *VersionEndpoint

NewVersionEndpoint ...

func (*VersionEndpoint) ServerVersion added in v0.0.24 

func (v *VersionEndpoint) ServerVersion() (ver m.Version)

ServerVersion ...

type Zigbee2mqttEndpoint added in v0.1.0 

type Zigbee2mqttEndpoint struct {
	*CommonEndpoint
}

Zigbee2mqttEndpoint ...

func NewZigbee2mqttEndpoint added in v0.1.0 

func NewZigbee2mqttEndpoint(common *CommonEndpoint) *Zigbee2mqttEndpoint

NewZigbee2mqttEndpoint ...

func (*Zigbee2mqttEndpoint) AddBridge added in v0.5.2 

func (n *Zigbee2mqttEndpoint) AddBridge(ctx context.Context, params *m.Zigbee2mqtt) (bridge *m.Zigbee2mqtt, err error)

AddBridge ...

func (*Zigbee2mqttEndpoint) Delete added in v0.1.0 

func (n *Zigbee2mqttEndpoint) Delete(ctx context.Context, id int64) (err error)

Delete ...

func (*Zigbee2mqttEndpoint) DeviceBan added in v0.1.0 

func (n *Zigbee2mqttEndpoint) DeviceBan(_ context.Context, id int64, friendlyName string) (err error)

DeviceBan ...

func (*Zigbee2mqttEndpoint) DeviceList added in v0.5.2 

func (n *Zigbee2mqttEndpoint) DeviceList(ctx context.Context, bridgeId int64, pagination common.PageParams) (result []*m.Zigbee2mqttDevice, total int64, err error)

DeviceList ...

func (*Zigbee2mqttEndpoint) DeviceRename added in v0.1.0 

func (n *Zigbee2mqttEndpoint) DeviceRename(_ context.Context, friendlyName, name string) (err error)

DeviceRename ...

func (*Zigbee2mqttEndpoint) DeviceWhitelist added in v0.1.0 

func (n *Zigbee2mqttEndpoint) DeviceWhitelist(_ context.Context, id int64, friendlyName string) (err error)

DeviceWhitelist ...

func (*Zigbee2mqttEndpoint) GetBridgeById added in v0.5.2 

func (n *Zigbee2mqttEndpoint) GetBridgeById(ctx context.Context, id int64) (bridge *m.Zigbee2mqtt, err error)

GetBridgeById ...

func (*Zigbee2mqttEndpoint) GetBridgeList added in v0.5.2 

func (n *Zigbee2mqttEndpoint) GetBridgeList(ctx context.Context, pagination common.PageParams) (list []*m.Zigbee2mqtt, total int64, err error)

GetBridgeList ...

func (*Zigbee2mqttEndpoint) Networkmap added in v0.1.0 

func (n *Zigbee2mqttEndpoint) Networkmap(_ context.Context, id int64) (networkmap string, err error)

Networkmap ...

func (*Zigbee2mqttEndpoint) ResetBridge added in v0.1.0 

func (n *Zigbee2mqttEndpoint) ResetBridge(_ context.Context, id int64) (err error)

ResetBridge ...

func (*Zigbee2mqttEndpoint) SearchDevice added in v0.1.0 

func (n *Zigbee2mqttEndpoint) SearchDevice(ctx context.Context, search common.SearchParams) (result []*m.Zigbee2mqttDevice, total int64, err error)

SearchDevice ...

func (*Zigbee2mqttEndpoint) UpdateBridge added in v0.5.2 

func (n *Zigbee2mqttEndpoint) UpdateBridge(ctx context.Context, params *m.Zigbee2mqtt) (bridge *m.Zigbee2mqtt, err error)

UpdateBridge ...

func (*Zigbee2mqttEndpoint) UpdateNetworkmap added in v0.1.0 

func (n *Zigbee2mqttEndpoint) UpdateNetworkmap(_ context.Context, id int64) (err error)

UpdateNetworkmap ...

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.