Documentation
¶
Overview ¶
Package socketcfg provides apiconnector client connection settings
Index ¶
- type Socketcfg
- func (s *Socketcfg) EncodeData() string
- func (s *Socketcfg) SetCredentials(username string, password string, otpcode string)
- func (s *Socketcfg) SetEntity(entityid string)
- func (s *Socketcfg) SetIPAddress(ip string)
- func (s *Socketcfg) SetSession(sessionid string)
- func (s *Socketcfg) SetUser(username string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Socketcfg ¶
type Socketcfg struct {
// contains filtered or unexported fields
}
Socketcfg is a struct representing connection settings used as POST data for http request against the insanely fast 1API backend API.
func (*Socketcfg) EncodeData ¶
EncodeData method to return the struct data ready to submit within POST request of type "application/x-www-form-urlencoded"
func (*Socketcfg) SetCredentials ¶
SetCredentials method to set username and password to use for api communication
func (*Socketcfg) SetEntity ¶
SetEntity method to set the system entity id used to communicate with "1234" -> OT&E system, "54cd" -> LIVE system
func (*Socketcfg) SetIPAddress ¶ added in v1.2.1
SetIPAddress method to set remote ip address to be submitted to the HEXONET API. This ip address is being considered when you have ip filter settings activated. To reset this, simply provide an empty string as parameter.
func (*Socketcfg) SetSession ¶
SetSession method to set a API session id to use for api communication instead of credentials which is basically required in case you plan to use session based communication or if you want to use 2FA