android

Documentation

Index

• type Auth
  • func NewAuth(cfgPath string, mgmURL string) (*Auth, error)
  • func NewAuthWithConfig(ctx context.Context, config *internal.Config) *Auth
  • func (a *Auth) Login(resultListener ErrListener, urlOpener URLOpener)
  • func (a *Auth) LoginWithSetupKeyAndSaveConfig(resultListener ErrListener, setupKey string, deviceName string)
  • func (a *Auth) SaveConfigIfSSOSupported(listener SSOListener)
• type DNSList
  • func (array *DNSList) Add(s string)
  • func (array *DNSList) Get(i int) (string, error)
  • func (array *DNSList) Size() int
• type ErrListener
• type PeerInfo
• type PeerInfoArray
  • func (array PeerInfoArray) Add(s PeerInfo) PeerInfoArray
  • func (array PeerInfoArray) Get(i int) *PeerInfo
  • func (array PeerInfoArray) Size() int
• type PeerInfoCollection
• type Preferences
  • func NewPreferences(configPath string) *Preferences
  • func (p *Preferences) Commit() error
  • func (p *Preferences) GetAdminURL() (string, error)
  • func (p *Preferences) GetManagementURL() (string, error)
  • func (p *Preferences) GetPreSharedKey() (string, error)
  • func (p *Preferences) SetAdminURL(url string)
  • func (p *Preferences) SetManagementURL(url string)
  • func (p *Preferences) SetPreSharedKey(key string)
• type SSOListener
• type URLOpener

Types

type Auth

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

Auth can register or login new client

func NewAuth

func NewAuth(cfgPath string, mgmURL string) (*Auth, error)

NewAuth instantiate Auth struct and validate the management URL

func NewAuthWithConfig

func NewAuthWithConfig(ctx context.Context, config *internal.Config) *Auth

NewAuthWithConfig instantiate Auth based on existing config

func (*Auth) Login

func (a *Auth) Login(resultListener ErrListener, urlOpener URLOpener)

Login try register the client on the server

func (*Auth) LoginWithSetupKeyAndSaveConfig

func (a *Auth) LoginWithSetupKeyAndSaveConfig(resultListener ErrListener, setupKey string, deviceName string)

LoginWithSetupKeyAndSaveConfig test the connectivity with the management server with the setup key.

func (*Auth) SaveConfigIfSSOSupported

func (a *Auth) SaveConfigIfSSOSupported(listener SSOListener)

SaveConfigIfSSOSupported test the connectivity with the management server by retrieving the server device flow info. If it returns a flow info than save the configuration and return true. If it gets a codes.NotFound, it means that SSO is not supported and returns false without saving the configuration. For other errors return false.

type DNSList

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

DNSList is a wrapper of []string

func (*DNSList) Add

func (array *DNSList) Add(s string)

Add new DNS address to the collection

func (*DNSList) Get

func (array *DNSList) Get(i int) (string, error)

Get return an element of the collection

func (*DNSList) Size

func (array *DNSList) Size() int

Size return with the size of the collection

type ErrListener

type ErrListener interface {
	OnSuccess()
	OnError(error)
}

ErrListener is async listener for mobile framework

type PeerInfo

type PeerInfo struct {
	IP         string
	FQDN       string
	ConnStatus string // Todo replace to enum
}

PeerInfo describe information about the peers. It designed for the UI usage

type PeerInfoArray

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

PeerInfoArray is the implementation of the PeerInfoCollection

func (PeerInfoArray) Add

func (array PeerInfoArray) Add(s PeerInfo) PeerInfoArray

Add new PeerInfo to the collection

func (PeerInfoArray) Get

func (array PeerInfoArray) Get(i int) *PeerInfo

Get return an element of the collection

func (PeerInfoArray) Size

func (array PeerInfoArray) Size() int

Size return with the size of the collection

type PeerInfoCollection

type PeerInfoCollection interface {
	Add(s string) PeerInfoCollection
	Get(i int) string
	Size() int
}

PeerInfoCollection made for Java layer to get non default types as collection

type Preferences

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

Preferences export a subset of the internal config for gomobile

func NewPreferences

func NewPreferences(configPath string) *Preferences

NewPreferences create new Preferences instance

func (*Preferences) Commit

func (p *Preferences) Commit() error

Commit write out the changes into config file

func (*Preferences) GetAdminURL

func (p *Preferences) GetAdminURL() (string, error)

GetAdminURL read url from config file

func (*Preferences) GetManagementURL

func (p *Preferences) GetManagementURL() (string, error)

GetManagementURL read url from config file

func (*Preferences) GetPreSharedKey

func (p *Preferences) GetPreSharedKey() (string, error)

GetPreSharedKey read preshared key from config file

func (*Preferences) SetAdminURL

func (p *Preferences) SetAdminURL(url string)

SetAdminURL store the given url and wait for commit

func (*Preferences) SetManagementURL

func (p *Preferences) SetManagementURL(url string)

SetManagementURL store the given url and wait for commit

func (*Preferences) SetPreSharedKey

func (p *Preferences) SetPreSharedKey(key string)

SetPreSharedKey store the given key and wait for commit

type SSOListener

type SSOListener interface {
	OnSuccess(bool)
	OnError(error)
}

SSOListener is async listener for mobile framework

type URLOpener

type URLOpener interface {
	Open(string)
}

URLOpener it is a callback interface. The Open function will be triggered if the backend want to show an url for the user