interactives

Documentation

Index

• Constants
• type Client
  • func NewAPIClient(interactivesAPIURL, version string) *Client
  • func NewAPIClientWithMaxRetries(interactivesAPIURL, version string, maxRetries int) *Client
  • func NewWithHealthClient(hcCli *healthcheck.Client, version string) *Client
  • func (c *Client) Checker(ctx context.Context, check *health.CheckState) error
  • func (c *Client) GetInteractive(ctx context.Context, userAuthToken, serviceAuthToken string, ...) (m Interactive, err error)
  • func (c *Client) ListInteractives(ctx context.Context, userAuthToken, serviceAuthToken string, q *QueryParams) (m List, err error)
  • func (c *Client) PutInteractive(ctx context.Context, userAuthToken, serviceAuthToken, interactiveID string, ...) error
• type ErrInvalidInteractivesAPIResponse
  • func NewInteractivesAPIResponse(resp *http.Response, uri string) (e *ErrInvalidInteractivesAPIResponse)
  • func (e ErrInvalidInteractivesAPIResponse) Error() string
• type Interactive
• type InteractiveArchive
• type InteractiveFile
• type InteractiveMetadata
• type InteractiveUpdate
• type List
• type QueryParams
  • func (q *QueryParams) Validate() error

Constants

const (
	UpdateFormFieldKey = "update"
)

Types

type Client

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

Client is a interactives api client which can be used to make requests to the server

func NewAPIClient

func NewAPIClient(interactivesAPIURL, version string) *Client

NewAPIClient creates a new instance of Client with a given interactive api url and the relevant tokens

func NewAPIClientWithMaxRetries

func NewAPIClientWithMaxRetries(interactivesAPIURL, version string, maxRetries int) *Client

NewAPIClientWithMaxRetries creates a new instance of Client with a given interactive api url and the relevant tokens, setting a number of max retires for the HTTP client

func NewWithHealthClient

func NewWithHealthClient(hcCli *healthcheck.Client, version string) *Client

NewWithHealthClient creates a new instance of Client, reusing the URL and Clienter from the provided health check client.

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *health.CheckState) error

Checker calls interactives api health endpoint and returns a check object to the caller.

func (*Client) GetInteractive

func (c *Client) GetInteractive(ctx context.Context, userAuthToken, serviceAuthToken string, interactivesID string) (m Interactive, err error)

GetInteractive returns an interactive (given the id)

func (*Client) ListInteractives

func (c *Client) ListInteractives(ctx context.Context, userAuthToken, serviceAuthToken string, q *QueryParams) (m List, err error)

ListInteractives returns the list of interactives

func (*Client) PutInteractive

func (c *Client) PutInteractive(ctx context.Context, userAuthToken, serviceAuthToken, interactiveID string, update InteractiveUpdate) error

PutInteractive update the dataset

type ErrInvalidInteractivesAPIResponse

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

ErrInvalidInteractivesAPIResponse is returned when the interactives api does not respond with a valid status

func NewInteractivesAPIResponse

func NewInteractivesAPIResponse(resp *http.Response, uri string) (e *ErrInvalidInteractivesAPIResponse)

NewInteractivesAPIResponse creates an error response, optionally adding body to e when status is 404

func (ErrInvalidInteractivesAPIResponse) Error

func (e ErrInvalidInteractivesAPIResponse) Error() string

type Interactive

type Interactive struct {
	ID        string               `json:"id,omitempty"`
	Published *bool                `json:"published,omitempty"`
	Metadata  *InteractiveMetadata `json:"metadata,omitempty"`
	Archive   *InteractiveArchive  `json:"archive,omitempty"`
}

type InteractiveArchive

type InteractiveArchive struct {
	Name  string             `json:"name,omitempty"`
	Size  int64              `json:"size_in_bytes,omitempty"`
	Files []*InteractiveFile `json:"files,omitempty"`
}

type InteractiveFile

type InteractiveFile struct {
	Name     string `json:"name,omitempty"`
	Mimetype string `json:"mimetype,omitempty"`
	Size     int64  `json:"size_in_bytes,omitempty"`
}

type InteractiveMetadata

type InteractiveMetadata struct {
	Title             string `json:"title,omitempty"`
	Label             string `json:"label,omitempty"`
	InternalID        string `json:"internal_id,omitempty"`
	CollectionID      string `json:"collection_id,omitempty"`
	HumanReadableSlug string `json:"slug,omitempty"`
	ResourceID        string `json:"resource_id,omitempty"`
}

type InteractiveUpdate

type InteractiveUpdate struct {
	ImportSuccessful *bool       `json:"import_successful,omitempty"`
	ImportMessage    string      `json:"import_message,omitempty"`
	Interactive      Interactive `json:"interactive,omitempty"`
}

type List

type List struct {
	Items      []Interactive `json:"items"`
	Count      int           `json:"count"`
	Offset     int           `json:"offset"`
	Limit      int           `json:"limit"`
	TotalCount int           `json:"total_count"`
}

type QueryParams

type QueryParams struct {
	Offset int
	Limit  int
	Filter *InteractiveMetadata
}

QueryParams represents the possible query parameters that a caller can provide

func (*QueryParams) Validate

func (q *QueryParams) Validate() error