algoliasearch

Documentation

Index

• type Client
  • func NewClient(appID, apiKey string) *Client
  • func NewClientWithHosts(appID, apiKey string, hosts []string) *Client
  • func (c *Client) AddKey(acl, indexes []string, validity int, maxQueriesPerIPPerHour int, ...) (interface{}, error)
  • func (c *Client) AddKeyWithParam(params interface{}) (interface{}, error)
  • func (c *Client) CopyIndex(source string, destination string) (interface{}, error)
  • func (c *Client) CustomBatch(queries interface{}) (interface{}, error)
  • func (c *Client) DeleteKey(key string) (interface{}, error)
  • func (c *Client) EncodeParams(body interface{}) string
  • func (c *Client) GenerateSecuredApiKey(apiKey string, public interface{}, userToken ...string) (string, error)
  • func (c *Client) GetKey(key string) (interface{}, error)
  • func (c *Client) GetLogs(offset, length int, logType string) (interface{}, error)
  • func (c *Client) InitIndex(indexName string) *Index
  • func (c *Client) ListIndexes() (interface{}, error)
  • func (c *Client) ListKeys() (interface{}, error)
  • func (c *Client) MoveIndex(source string, destination string) (interface{}, error)
  • func (c *Client) MultipleQueries(queries []interface{}, optionals ...string) (interface{}, error)
  • func (c *Client) SetExtraHeader(key string, value string)
  • func (c *Client) SetTimeout(connectTimeout int, readTimeout int)
  • func (c *Client) UpdateKey(key string, acl, indexes []string, validity int, maxQueriesPerIPPerHour int, ...) (interface{}, error)
  • func (c *Client) UpdateKeyWithParam(key string, params interface{}) (interface{}, error)
• type Index
  • func NewIndex(name string, client *Client) *Index
  • func (i *Index) AddKey(acl []string, validity int, maxQueriesPerIPPerHour int, maxHitsPerQuery int) (interface{}, error)
  • func (i *Index) AddKeyWithParam(params interface{}) (interface{}, error)
  • func (i *Index) AddObject(object interface{}) (interface{}, error)
  • func (i *Index) AddObjects(objects interface{}) (interface{}, error)
  • func (i *Index) Batch(objects interface{}, actions []string) (interface{}, error)
  • func (i *Index) Browse(page, hitsPerPage int) (interface{}, error)
  • func (i *Index) BrowseAll(params interface{}) (*IndexIterator, error)
  • func (i *Index) BrowseFrom(params interface{}, cursor string) (interface{}, error)
  • func (i *Index) Clear() (interface{}, error)
  • func (i *Index) Copy(name string) (interface{}, error)
  • func (i *Index) CustomBatch(queries interface{}) (interface{}, error)
  • func (i *Index) Delete() (interface{}, error)
  • func (i *Index) DeleteByQuery(query string, params map[string]interface{}) (interface{}, error)
  • func (i *Index) DeleteKey(key string) (interface{}, error)
  • func (i *Index) DeleteObject(objectID string) (interface{}, error)
  • func (i *Index) DeleteObjects(objectIDs []string) (interface{}, error)
  • func (i *Index) GetKey(key string) (interface{}, error)
  • func (i *Index) GetObject(objectID string, attribute ...string) (interface{}, error)
  • func (i *Index) GetObjects(objectIDs ...string) (interface{}, error)
  • func (i *Index) GetSettings() (interface{}, error)
  • func (i *Index) ListKeys() (interface{}, error)
  • func (i *Index) Move(name string) (interface{}, error)
  • func (i *Index) PartialUpdateObject(object interface{}) (interface{}, error)
  • func (i *Index) PartialUpdateObjects(objects interface{}) (interface{}, error)
  • func (i *Index) Search(query string, params interface{}) (interface{}, error)
  • func (i *Index) SetSettings(settings interface{}) (interface{}, error)
  • func (i *Index) UpdateKey(key string, acl []string, validity int, maxQueriesPerIPPerHour int, ...) (interface{}, error)
  • func (i *Index) UpdateKeyWithParam(key string, params interface{}) (interface{}, error)
  • func (i *Index) UpdateObject(object interface{}) (interface{}, error)
  • func (i *Index) UpdateObjects(objects interface{}) (interface{}, error)
  • func (i *Index) WaitTask(task interface{}) (interface{}, error)
  • func (i *Index) WaitTaskWithInit(taskID float64, timeToWait float64) (interface{}, error)
• type IndexIterator
  • func (it *IndexIterator) GetCursor() (string, bool)
  • func (it *IndexIterator) Next() (interface{}, error)
• type Transport
  • func NewTransport(appID, apiKey string) *Transport
  • func NewTransportWithHosts(appID, apiKey string, hosts []string) *Transport
  • func (t *Transport) EncodeParams(params interface{}) string

Types

type Client

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

func NewClient

func NewClient(appID, apiKey string) *Client

func NewClientWithHosts

func NewClientWithHosts(appID, apiKey string, hosts []string) *Client

func (*Client) AddKey

func (c *Client) AddKey(acl, indexes []string, validity int, maxQueriesPerIPPerHour int, maxHitsPerQuery int) (interface{}, error)

func (*Client) AddKeyWithParam

func (c *Client) AddKeyWithParam(params interface{}) (interface{}, error)

func (*Client) CopyIndex

func (c *Client) CopyIndex(source string, destination string) (interface{}, error)

func (*Client) CustomBatch

func (c *Client) CustomBatch(queries interface{}) (interface{}, error)

func (*Client) DeleteKey

func (c *Client) DeleteKey(key string) (interface{}, error)

func (*Client) EncodeParams

func (c *Client) EncodeParams(body interface{}) string

func (*Client) GenerateSecuredApiKey

func (c *Client) GenerateSecuredApiKey(apiKey string, public interface{}, userToken ...string) (string, error)

func (*Client) GetKey

func (c *Client) GetKey(key string) (interface{}, error)

func (*Client) GetLogs

func (c *Client) GetLogs(offset, length int, logType string) (interface{}, error)

func (*Client) InitIndex

func (c *Client) InitIndex(indexName string) *Index

func (*Client) ListIndexes

func (c *Client) ListIndexes() (interface{}, error)

func (*Client) ListKeys

func (c *Client) ListKeys() (interface{}, error)

func (*Client) MoveIndex

func (c *Client) MoveIndex(source string, destination string) (interface{}, error)

func (*Client) MultipleQueries

func (c *Client) MultipleQueries(queries []interface{}, optionals ...string) (interface{}, error)

func (*Client) SetExtraHeader

func (c *Client) SetExtraHeader(key string, value string)

func (*Client) SetTimeout

func (c *Client) SetTimeout(connectTimeout int, readTimeout int)

func (*Client) UpdateKey

func (c *Client) UpdateKey(key string, acl, indexes []string, validity int, maxQueriesPerIPPerHour int, maxHitsPerQuery int) (interface{}, error)

func (*Client) UpdateKeyWithParam

func (c *Client) UpdateKeyWithParam(key string, params interface{}) (interface{}, error)

type Index

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

func NewIndex

func NewIndex(name string, client *Client) *Index

func (*Index) AddKey

func (i *Index) AddKey(acl []string, validity int, maxQueriesPerIPPerHour int, maxHitsPerQuery int) (interface{}, error)

func (*Index) AddKeyWithParam

func (i *Index) AddKeyWithParam(params interface{}) (interface{}, error)

func (*Index) AddObject

func (i *Index) AddObject(object interface{}) (interface{}, error)

func (*Index) AddObjects

func (i *Index) AddObjects(objects interface{}) (interface{}, error)

func (*Index) Batch

func (i *Index) Batch(objects interface{}, actions []string) (interface{}, error)

func (*Index) Browse

func (i *Index) Browse(page, hitsPerPage int) (interface{}, error)

Deprecated use BrowseFrom or BrowseAll

func (*Index) BrowseAll

func (i *Index) BrowseAll(params interface{}) (*IndexIterator, error)

func (*Index) BrowseFrom

func (i *Index) BrowseFrom(params interface{}, cursor string) (interface{}, error)

func (*Index) Clear

func (i *Index) Clear() (interface{}, error)

func (*Index) Copy

func (i *Index) Copy(name string) (interface{}, error)

func (*Index) CustomBatch

func (i *Index) CustomBatch(queries interface{}) (interface{}, error)

func (*Index) Delete

func (i *Index) Delete() (interface{}, error)

func (*Index) DeleteByQuery

func (i *Index) DeleteByQuery(query string, params map[string]interface{}) (interface{}, error)

func (*Index) DeleteKey

func (i *Index) DeleteKey(key string) (interface{}, error)

func (*Index) DeleteObject

func (i *Index) DeleteObject(objectID string) (interface{}, error)

func (*Index) DeleteObjects

func (i *Index) DeleteObjects(objectIDs []string) (interface{}, error)

func (*Index) GetKey

func (i *Index) GetKey(key string) (interface{}, error)

func (*Index) GetObject

func (i *Index) GetObject(objectID string, attribute ...string) (interface{}, error)

func (*Index) GetObjects

func (i *Index) GetObjects(objectIDs ...string) (interface{}, error)

func (*Index) GetSettings

func (i *Index) GetSettings() (interface{}, error)

func (*Index) ListKeys

func (i *Index) ListKeys() (interface{}, error)

func (*Index) Move

func (i *Index) Move(name string) (interface{}, error)

func (*Index) PartialUpdateObject

func (i *Index) PartialUpdateObject(object interface{}) (interface{}, error)

func (*Index) PartialUpdateObjects

func (i *Index) PartialUpdateObjects(objects interface{}) (interface{}, error)

func (*Index) Search

func (i *Index) Search(query string, params interface{}) (interface{}, error)

func (*Index) SetSettings

func (i *Index) SetSettings(settings interface{}) (interface{}, error)

func (*Index) UpdateKey

func (i *Index) UpdateKey(key string, acl []string, validity int, maxQueriesPerIPPerHour int, maxHitsPerQuery int) (interface{}, error)

func (*Index) UpdateKeyWithParam

func (i *Index) UpdateKeyWithParam(key string, params interface{}) (interface{}, error)

func (*Index) UpdateObject

func (i *Index) UpdateObject(object interface{}) (interface{}, error)

func (*Index) UpdateObjects

func (i *Index) UpdateObjects(objects interface{}) (interface{}, error)

func (*Index) WaitTask

func (i *Index) WaitTask(task interface{}) (interface{}, error)

func (*Index) WaitTaskWithInit

func (i *Index) WaitTaskWithInit(taskID float64, timeToWait float64) (interface{}, error)

type IndexIterator

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

func (*IndexIterator) GetCursor

func (it *IndexIterator) GetCursor() (string, bool)

func (*IndexIterator) Next

func (it *IndexIterator) Next() (interface{}, error)

type Transport

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

func NewTransport

func NewTransport(appID, apiKey string) *Transport

func NewTransportWithHosts

func NewTransportWithHosts(appID, apiKey string, hosts []string) *Transport

func (*Transport) EncodeParams

func (t *Transport) EncodeParams(params interface{}) string