meilisearch_ex v1.1.2

View Source Meilisearch.Settings.DisplayedAttributes (meilisearch_ex v1.1.2)

see documentation

Link to this section Summary

Functions

get(client, index_uid)

Get displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

reset(client, index_uid)

Reset displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

update(client, index_uid, params)

Update displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

Link to this section Functions

Link to this function

get(client, index_uid)

View Source 
@spec get(Tesla.Client.t(), String.t()) ::
  {:ok, [String.t()]} | {:error, Meilisearch.Client.error()}

Get displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.DisplayedAttributes.get(client, "movies")
{:ok, ["title", "overview", "genres", "release_date.year"]}
Link to this function

reset(client, index_uid)

View Source 
@spec reset(Tesla.Client.t(), String.t()) ::
  {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}

Reset displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.DisplayedAttributes.reset(client, "movies")
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}
Link to this function

update(client, index_uid, params)

View Source 
@spec update(Tesla.Client.t(), String.t(), [String.t()]) ::
  {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}

Update displayed attributes settings of an Index of your Meilisearch instance. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.DisplayedAttributes.update(client, "movies", ["title", "overview", "genres", "release_date"])
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}