synoapi

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(base_url string) *Client
  • func (c *Client) ListShares() ([]Share, error)
  • func (c *Client) LockShare(name string) error
  • func (c *Client) Login(user string, password string) error
  • func (c *Client) UnlockShare(name string, password string) error
• type ClientError
  • func NewClientError(context string, err error) ClientError
• type EncryptionStatus
  • func (e EncryptionStatus) String() string
• type ListSharesResponse
  • func (s *ListSharesResponse) ErrorCode() int
  • func (s *ListSharesResponse) Successful() bool
• type LoginResponse
  • func (s *LoginResponse) ErrorCode() int
  • func (s *LoginResponse) Successful() bool
• type Share
• type SynoBaseResponse
• type SynoError
  • func NewSynoError(code int) SynoError
• type SynoResponse
  • func (s *SynoResponse) ErrorCode() int
  • func (s *SynoResponse) Successful() bool

Constants

const (
	NOT_ENCRYPTED      = 0
	ENCRYPTED_LOCKED   = 1
	ENCRYPTED_UNLOCKED = 2
)

Variables

var SYNO_ERR_CODES = map[int]string{
	402:  "This shared folder doesn't exist.",
	3308: "The password is invalid.",
}

Types

type Client

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

func NewClient

func NewClient(base_url string) *Client

func (*Client) ListShares

func (c *Client) ListShares() ([]Share, error)

func (*Client) LockShare

func (c *Client) LockShare(name string) error

func (*Client) Login

func (c *Client) Login(user string, password string) error

func (*Client) UnlockShare

func (c *Client) UnlockShare(name string, password string) error

type ClientError

type ClientError interface {
	error
	UnderlyingError() error
}

func NewClientError

func NewClientError(context string, err error) ClientError

type EncryptionStatus

type EncryptionStatus int8

func (EncryptionStatus) String

func (e EncryptionStatus) String() string

type ListSharesResponse

type ListSharesResponse struct {
	Data struct {
		Shares []Share
	}
	// contains filtered or unexported fields
}

func (*ListSharesResponse) ErrorCode

func (s *ListSharesResponse) ErrorCode() int

func (*ListSharesResponse) Successful

func (s *ListSharesResponse) Successful() bool

type LoginResponse

type LoginResponse struct {
	Data struct {
		Sid string
	}
	// contains filtered or unexported fields
}

func (*LoginResponse) ErrorCode

func (s *LoginResponse) ErrorCode() int

func (*LoginResponse) Successful

func (s *LoginResponse) Successful() bool

type Share

type Share struct {
	Description string `json:"desc"`
	Encryption  EncryptionStatus
	Name        string
	// contains filtered or unexported fields
}

type SynoBaseResponse

type SynoBaseResponse interface {
	ErrorCode() int
	Successful() bool
}

type SynoError

type SynoError interface {
	ClientError
	Code() int
	Description() string
}

func NewSynoError

func NewSynoError(code int) SynoError

type SynoResponse

type SynoResponse struct {
	Data map[string]interface{}
	// contains filtered or unexported fields
}

func (*SynoResponse) ErrorCode

func (s *SynoResponse) ErrorCode() int

func (*SynoResponse) Successful

func (s *SynoResponse) Successful() bool