fritzclient

Documentation

Index

• type Client
  • func New(configfile string) (*Client, error)
  • func (client *Client) Login() (*Client, error)
• type SessionInfo

Types

type Client

type Client struct {
	Config *config.Config // The client configuration.

	HTTPClient  *http.Client // The HTTP client.
	SessionInfo *SessionInfo // The current session data of the client.
	// contains filtered or unexported fields
}

Client encapsulates the FRITZ!Box interaction API.

func New

func New(configfile string) (*Client, error)

New creates a new Client with values read from a config file, given by the parameter configfile.

func (*Client) Login

func (client *Client) Login() (*Client, error)

Login tries to login into the box and obtain the session id.

type SessionInfo

type SessionInfo struct {
	Challenge string // A challenge provided by the FRITZ!Box.
	SID       string // The session id issued by the FRITZ!Box, "0000000000000000" is considered invalid/"no session".
}

SessionInfo models the xml upon accessing the login endpoint.