option

Documentation

Index

• type ClientOption
  • func WithCredentials(username, password string) ClientOption
  • func WithEndpoint(e string) ClientOption
  • func WithTransport(t http.RoundTripper) ClientOption

Types

type ClientOption

type ClientOption interface {
	Apply(*internal.ClientSettings)
}

A ClientOption is an option for the UniFi Controller client.

func WithCredentials

func WithCredentials(username, password string) ClientOption

WithCredentials returns a ClientOption that specifies the credentials to use to authenticate to the UniFi Controller.

func WithEndpoint

func WithEndpoint(e string) ClientOption

WithEndpoint returns a ClientOption that overrides the default UniFi Controller endpoint.

func WithTransport

func WithTransport(t http.RoundTripper) ClientOption

WithTransport returns a ClientOption that specifies the HTTP transport to use.