icsgo

README

ics-go-sdk

ics golang restapi client

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, u *url.URL, insecure bool) (*Client, error)
  • func (c *Client) Login(ctx context.Context, u *url.Userinfo) error
  • func (c *Client) Logout(ctx context.Context) error
• type DefaultMultipleFoundError
  • func (e DefaultMultipleFoundError) Error() string
• type DefaultNotFoundError
  • func (e *DefaultNotFoundError) Error() string
• type ICSConnection
  • func (connection *ICSConnection) Connect(ctx context.Context) error
  • func (connection *ICSConnection) GetClient() (*client.Client, error)
  • func (connection *ICSConnection) Logout(ctx context.Context) error
  • func (connection *ICSConnection) NewClient(ctx context.Context) (*client.Client, error)
  • func (connection *ICSConnection) UpdateCredentials(username string, password string)
• type MultipleFoundError
  • func (e *MultipleFoundError) Error() string
• type NotFoundError
  • func (e *NotFoundError) Error() string

Types

type Client

type Client struct {
	*client.Client

	SessionManager *session.Manager
}

func NewClient

func NewClient(ctx context.Context, u *url.URL, insecure bool) (*Client, error)

NewClient creates a new client from a URL. The client authenticates with the server with username/password before returning if the URL contains user information.

func (*Client) Login

func (c *Client) Login(ctx context.Context, u *url.Userinfo) error

Login dispatches to the SessionManager.

func (*Client) Logout

func (c *Client) Logout(ctx context.Context) error

Logout dispatches to the SessionManager.

type DefaultMultipleFoundError

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

func (DefaultMultipleFoundError) Error

func (e DefaultMultipleFoundError) Error() string

type DefaultNotFoundError

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

func (*DefaultNotFoundError) Error

func (e *DefaultNotFoundError) Error() string

type ICSConnection

type ICSConnection struct {
	Client          *client.Client
	Username        string
	Password        string
	Hostname        string
	Port            string
	AccessKeyID     string
	AccessKeySecret string
	Insecure        bool
	// contains filtered or unexported fields
}

func (*ICSConnection) Connect

func (connection *ICSConnection) Connect(ctx context.Context) error

func (*ICSConnection) GetClient

func (connection *ICSConnection) GetClient() (*client.Client, error)

NewClient creates a new ics-go-sdk client for the ICSConnection obj

func (*ICSConnection) Logout

func (connection *ICSConnection) Logout(ctx context.Context) error

Logout calls SessionManager.Logout for the given connection.

func (*ICSConnection) NewClient

func (connection *ICSConnection) NewClient(ctx context.Context) (*client.Client, error)

NewClient creates a new ics-go-sdk client for the ICSConnection obj

func (*ICSConnection) UpdateCredentials

func (connection *ICSConnection) UpdateCredentials(username string, password string)

UpdateCredentials updates username and password. Note: Updated username and password will be used when there is no session active

type MultipleFoundError

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

func (*MultipleFoundError) Error

func (e *MultipleFoundError) Error() string

type NotFoundError

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

func (*NotFoundError) Error

func (e *NotFoundError) Error() string