Intel471Ex.Actors (intel471_ex v0.1.0)

Functions for working with the Intel 471 Titan Actors API.

Summary

Functions

get(uid)

Get a single actor by UID.

search(params \\ %{})

Search actors using filter criteria.

Functions

get(uid)

@spec get(String.t()) :: {:ok, map()} | {:error, any()}

Get a single actor by UID.

Parameters

  • uid: The unique identifier of the actor

Examples 

iex> Intel471Ex.Actors.get("e7fafbb8f44a6ded005c154976627da4")
{:ok, %{...}}

search(params \\ %{})

@spec search(map()) :: {:ok, map()} | {:error, any()}

Search actors using filter criteria.

Parameters

  • params: A map of query parameters for filtering actors
    • :actor - Search for handles only
    • :forum - Search for actors active on given forum
    • :from - Search data starting from given creation time
    • :until - Search data ending before given creation time
    • :lastUpdatedFrom - Search data starting from given last updated time
    • :lastUpdatedUntil - Search data ending before given last updated time
    • :sort - Sort results (relevance, earliest, latest)
    • :offset - Skip leading number of records
    • :count - Returns given number of records

Examples 

iex> Intel471Ex.Actors.search(%{actor: "synthx"})
{:ok, %{"actorTotalCount" => 35, "actors" => [...]}}