admin_policy

Documentation

Overview

BlueZ D-Bus Admin Policy API description [admin-policy-api.txt] This API provides methods to control the behavior of bluez as an administrator.

Interface AdminPolicySet1 provides methods to set policies. Once the policy is set successfully, it will affect all clients and stay persistently even after restarting Bluetooth Daemon. The only way to clear it is to overwrite the policy with the same method.

Interface AdminPolicyStatus1 provides readonly properties to indicate the current values of admin policy.

Index

• Variables
• type AdminPolicySet1
  • func NewAdminPolicySet1(objectPath dbus.ObjectPath) (*AdminPolicySet1, error)
  • func (a *AdminPolicySet1) Client() *bluez.Client
  • func (a *AdminPolicySet1) Close()
  • func (a *AdminPolicySet1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)
  • func (a *AdminPolicySet1) GetProperties() (*AdminPolicySet1Properties, error)
  • func (a *AdminPolicySet1) GetPropertiesSignal() (chan *dbus.Signal, error)
  • func (a *AdminPolicySet1) GetProperty(name string) (dbus.Variant, error)
  • func (a *AdminPolicySet1) GetWatchPropertiesChannel() chan *dbus.Signal
  • func (a *AdminPolicySet1) Interface() string
  • func (a *AdminPolicySet1) Path() dbus.ObjectPath
  • func (a *AdminPolicySet1) SetProperty(name string, value interface{}) error
  • func (a *AdminPolicySet1) SetServiceAllowList(UUIDs []string) error
  • func (a *AdminPolicySet1) SetWatchPropertiesChannel(c chan *dbus.Signal)
  • func (a *AdminPolicySet1) ToProps() bluez.Properties
  • func (a *AdminPolicySet1) UnwatchProperties(ch chan *bluez.PropertyChanged) error
  • func (a *AdminPolicySet1) WatchProperties() (chan *bluez.PropertyChanged, error)
• type AdminPolicySet1Properties
  • func (a *AdminPolicySet1Properties) FromDBusMap(props map[string]dbus.Variant) (*AdminPolicySet1Properties, error)
  • func (a *AdminPolicySet1Properties) FromMap(props map[string]interface{}) (*AdminPolicySet1Properties, error)
  • func (p *AdminPolicySet1Properties) Lock()
  • func (a *AdminPolicySet1Properties) ToMap() (map[string]interface{}, error)
  • func (p *AdminPolicySet1Properties) Unlock()
• type AdminPolicyStatus1
  • func NewAdminPolicyStatus1(objectPath dbus.ObjectPath) (*AdminPolicyStatus1, error)
  • func (a *AdminPolicyStatus1) Client() *bluez.Client
  • func (a *AdminPolicyStatus1) Close()
  • func (a *AdminPolicyStatus1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)
  • func (a *AdminPolicyStatus1) GetProperties() (*AdminPolicyStatus1Properties, error)
  • func (a *AdminPolicyStatus1) GetPropertiesSignal() (chan *dbus.Signal, error)
  • func (a *AdminPolicyStatus1) GetProperty(name string) (dbus.Variant, error)
  • func (a *AdminPolicyStatus1) GetServiceAllowList() ([]string, error)
  • func (a *AdminPolicyStatus1) GetWatchPropertiesChannel() chan *dbus.Signal
  • func (a *AdminPolicyStatus1) Interface() string
  • func (a *AdminPolicyStatus1) Path() dbus.ObjectPath
  • func (a *AdminPolicyStatus1) SetProperty(name string, value interface{}) error
  • func (a *AdminPolicyStatus1) SetServiceAllowList(v []string) error
  • func (a *AdminPolicyStatus1) SetWatchPropertiesChannel(c chan *dbus.Signal)
  • func (a *AdminPolicyStatus1) ToProps() bluez.Properties
  • func (a *AdminPolicyStatus1) UnwatchProperties(ch chan *bluez.PropertyChanged) error
  • func (a *AdminPolicyStatus1) WatchProperties() (chan *bluez.PropertyChanged, error)
• type AdminPolicyStatus1Properties
  • func (a *AdminPolicyStatus1Properties) FromDBusMap(props map[string]dbus.Variant) (*AdminPolicyStatus1Properties, error)
  • func (a *AdminPolicyStatus1Properties) FromMap(props map[string]interface{}) (*AdminPolicyStatus1Properties, error)
  • func (p *AdminPolicyStatus1Properties) Lock()
  • func (a *AdminPolicyStatus1Properties) ToMap() (map[string]interface{}, error)
  • func (p *AdminPolicyStatus1Properties) Unlock()

Variables

var AdminPolicySet1Interface = "org.bluez.AdminPolicySet1"

var AdminPolicyStatus1Interface = "org.bluez.AdminPolicyStatus1"

Types

type AdminPolicySet1

type AdminPolicySet1 struct {
	Properties *AdminPolicySet1Properties
	// contains filtered or unexported fields
}

AdminPolicySet1 Admin Policy Set hierarchy

func NewAdminPolicySet1

func NewAdminPolicySet1(objectPath dbus.ObjectPath) (*AdminPolicySet1, error)

NewAdminPolicySet1 create a new instance of AdminPolicySet1

Args: - objectPath: [variable prefix]/{hci0,hci1,...}

func (*AdminPolicySet1) Client

func (a *AdminPolicySet1) Client() *bluez.Client

Client return AdminPolicySet1 dbus client

func (*AdminPolicySet1) Close

func (a *AdminPolicySet1) Close()

Close the connection

func (*AdminPolicySet1) GetObjectManagerSignal

func (a *AdminPolicySet1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*AdminPolicySet1) GetProperties

func (a *AdminPolicySet1) GetProperties() (*AdminPolicySet1Properties, error)

GetProperties load all available properties

func (*AdminPolicySet1) GetPropertiesSignal

func (a *AdminPolicySet1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*AdminPolicySet1) GetProperty

func (a *AdminPolicySet1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*AdminPolicySet1) GetWatchPropertiesChannel

func (a *AdminPolicySet1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*AdminPolicySet1) Interface

func (a *AdminPolicySet1) Interface() string

Interface return AdminPolicySet1 interface

func (*AdminPolicySet1) Path

func (a *AdminPolicySet1) Path() dbus.ObjectPath

Path return AdminPolicySet1 object path

func (*AdminPolicySet1) SetProperty

func (a *AdminPolicySet1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*AdminPolicySet1) SetServiceAllowList

func (a *AdminPolicySet1) SetServiceAllowList(UUIDs []string) error

SetServiceAllowList This method sets the service allowlist by specifying

service UUIDs.
When SetServiceAllowList is called, bluez will block
incoming and outgoing connections to the service not in
UUIDs for all of the clients.
Any subsequent calls to this method will supersede any
previously set allowlist values.  Calling this method
with an empty array will allow any service UUIDs to be
used.
The default value is an empty array.
Possible errors: org.bluez.Error.InvalidArguments
		 org.bluez.Error.Failed

func (*AdminPolicySet1) SetWatchPropertiesChannel

func (a *AdminPolicySet1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*AdminPolicySet1) ToProps

func (a *AdminPolicySet1) ToProps() bluez.Properties

ToProps return the properties interface

func (*AdminPolicySet1) UnwatchProperties

func (a *AdminPolicySet1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*AdminPolicySet1) WatchProperties

func (a *AdminPolicySet1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type AdminPolicySet1Properties

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

AdminPolicySet1Properties contains the exposed properties of an interface

func (*AdminPolicySet1Properties) FromDBusMap

func (a *AdminPolicySet1Properties) FromDBusMap(props map[string]dbus.Variant) (*AdminPolicySet1Properties, error)

FromDBusMap convert a map to an AdminPolicySet1Properties

func (*AdminPolicySet1Properties) FromMap

func (a *AdminPolicySet1Properties) FromMap(props map[string]interface{}) (*AdminPolicySet1Properties, error)

FromMap convert a map to an AdminPolicySet1Properties

func (*AdminPolicySet1Properties) Lock

func (p *AdminPolicySet1Properties) Lock()

Lock access to properties

func (*AdminPolicySet1Properties) ToMap

func (a *AdminPolicySet1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a AdminPolicySet1Properties to map

func (*AdminPolicySet1Properties) Unlock

func (p *AdminPolicySet1Properties) Unlock()

Unlock access to properties

type AdminPolicyStatus1

type AdminPolicyStatus1 struct {
	Properties *AdminPolicyStatus1Properties
	// contains filtered or unexported fields
}

AdminPolicyStatus1 Admin Policy Status hierarchy

func NewAdminPolicyStatus1

func NewAdminPolicyStatus1(objectPath dbus.ObjectPath) (*AdminPolicyStatus1, error)

NewAdminPolicyStatus1 create a new instance of AdminPolicyStatus1

Args: - objectPath: [variable prefix]/{hci0,hci1,...}

func (*AdminPolicyStatus1) Client

func (a *AdminPolicyStatus1) Client() *bluez.Client

Client return AdminPolicyStatus1 dbus client

func (*AdminPolicyStatus1) Close

func (a *AdminPolicyStatus1) Close()

Close the connection

func (*AdminPolicyStatus1) GetObjectManagerSignal

func (a *AdminPolicyStatus1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*AdminPolicyStatus1) GetProperties

func (a *AdminPolicyStatus1) GetProperties() (*AdminPolicyStatus1Properties, error)

GetProperties load all available properties

func (*AdminPolicyStatus1) GetPropertiesSignal

func (a *AdminPolicyStatus1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*AdminPolicyStatus1) GetProperty

func (a *AdminPolicyStatus1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*AdminPolicyStatus1) GetServiceAllowList

func (a *AdminPolicyStatus1) GetServiceAllowList() ([]string, error)

GetServiceAllowList get ServiceAllowList value

func (*AdminPolicyStatus1) GetWatchPropertiesChannel

func (a *AdminPolicyStatus1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*AdminPolicyStatus1) Interface

func (a *AdminPolicyStatus1) Interface() string

Interface return AdminPolicyStatus1 interface

func (*AdminPolicyStatus1) Path

func (a *AdminPolicyStatus1) Path() dbus.ObjectPath

Path return AdminPolicyStatus1 object path

func (*AdminPolicyStatus1) SetProperty

func (a *AdminPolicyStatus1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*AdminPolicyStatus1) SetServiceAllowList

func (a *AdminPolicyStatus1) SetServiceAllowList(v []string) error

SetServiceAllowList set ServiceAllowList value

func (*AdminPolicyStatus1) SetWatchPropertiesChannel

func (a *AdminPolicyStatus1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*AdminPolicyStatus1) ToProps

func (a *AdminPolicyStatus1) ToProps() bluez.Properties

ToProps return the properties interface

func (*AdminPolicyStatus1) UnwatchProperties

func (a *AdminPolicyStatus1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*AdminPolicyStatus1) WatchProperties

func (a *AdminPolicyStatus1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type AdminPolicyStatus1Properties

type AdminPolicyStatus1Properties struct {

	/*
		ServiceAllowList Current value of service allow list.
	*/
	ServiceAllowList []string
	// contains filtered or unexported fields
}

AdminPolicyStatus1Properties contains the exposed properties of an interface

func (*AdminPolicyStatus1Properties) FromDBusMap

func (a *AdminPolicyStatus1Properties) FromDBusMap(props map[string]dbus.Variant) (*AdminPolicyStatus1Properties, error)

FromDBusMap convert a map to an AdminPolicyStatus1Properties

func (*AdminPolicyStatus1Properties) FromMap

func (a *AdminPolicyStatus1Properties) FromMap(props map[string]interface{}) (*AdminPolicyStatus1Properties, error)

FromMap convert a map to an AdminPolicyStatus1Properties

func (*AdminPolicyStatus1Properties) Lock

func (p *AdminPolicyStatus1Properties) Lock()

Lock access to properties

func (*AdminPolicyStatus1Properties) ToMap

func (a *AdminPolicyStatus1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a AdminPolicyStatus1Properties to map

func (*AdminPolicyStatus1Properties) Unlock

func (p *AdminPolicyStatus1Properties) Unlock()

Unlock access to properties