Spatio.Api.Search (spatio_sdk v0.0.2)

API calls for all endpoints tagged Search.

Summary

Functions

Cross-platform federated search. Fans out to every platform's per-platform search method in parallel, merges + dedupes results, and returns them in a relevance-then-recency ranking with per-platform cursors for pagination.

Functions

federated_search(connection, federated_search_request, opts \\ [])

@spec federated_search(
  Tesla.Env.client(),
  Spatio.Model.FederatedSearchRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, Spatio.Model.FederatedSearch200Response.t()}
  | {:error, Tesla.Env.t()}

Cross-platform federated search. Fans out to every platform's per-platform search method in parallel, merges + dedupes results, and returns them in a relevance-then-recency ranking with per-platform cursors for pagination.

Parameters

  • connection (Spatio.Connection): Connection to server
  • federated_search_request (FederatedSearchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Spatio.Model.FederatedSearch200Response.t} on success
  • {:error, Tesla.Env.t} on failure