Documentation
¶
Index ¶
Constants ¶
const ( // DefaultHost is the default Host // found in Meta (info) section of spec file DefaultHost string = "api.screenlyapp.com" // DefaultBasePath is the default BasePath // found in Meta (info) section of spec file DefaultBasePath string = "/api/v3" )
Variables ¶
var Default = NewHTTPClient(nil)
Default screenly API HTTP client.
var DefaultSchemes = []string{"https"}
DefaultSchemes are the default schemes found in Meta (info) section of spec file
Functions ¶
This section is empty.
Types ¶
type ScreenlyAPI ¶
type ScreenlyAPI struct {
Assets assets.ClientService
Groups groups.ClientService
Playlists playlists.ClientService
Screens screens.ClientService
Transport runtime.ClientTransport
}
ScreenlyAPI is a client for screenly API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *ScreenlyAPI
New creates a new screenly API client
func NewHTTPClient ¶
func NewHTTPClient(formats strfmt.Registry) *ScreenlyAPI
NewHTTPClient creates a new screenly API HTTP client.
func NewHTTPClientWithConfig ¶
func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *ScreenlyAPI
NewHTTPClientWithConfig creates a new screenly API HTTP client, using a customizable transport config.
func (*ScreenlyAPI) SetTransport ¶
func (c *ScreenlyAPI) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client and all its subresources
type TransportConfig ¶
TransportConfig contains the transport related info, found in the meta section of the spec file.
func DefaultTransportConfig ¶
func DefaultTransportConfig() *TransportConfig
DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.
func (*TransportConfig) WithBasePath ¶
func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
WithBasePath overrides the default basePath, provided by the meta section of the spec file.
func (*TransportConfig) WithHost ¶
func (cfg *TransportConfig) WithHost(host string) *TransportConfig
WithHost overrides the default host, provided by the meta section of the spec file.
func (*TransportConfig) WithSchemes ¶
func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig
WithSchemes overrides the default schemes, provided by the meta section of the spec file.
Source Files
Directories