UnifiApi.Protect.NVR (UnifiApi v0.4.0)

Copy Markdown View Source

UniFi Protect API — NVR information.

Retrieves NVR details including doorbell settings.

Response fields

  • id, modelKey, name
  • doorbellSettings — %{defaultMessageText, defaultMessageResetTimeoutMs, customMessages, customImages}

Summary

Functions

get(client, opts \\ [])

Gets NVR information.

Functions

get(client, opts \\ [])

@spec get(
  Req.Request.t(),
  keyword()
) :: {:ok, term()} | {:error, UnifiApi.Error.t()}

Gets NVR information.

Options

  • :raw — when true, return the raw response body binary (skips JSON decoding). Useful on heavy NVR responses that the caller wants to stream-parse.

Examples

{:ok, nvr} = UnifiApi.Protect.NVR.get(client)
nvr["name"]             # => "UNVR"
nvr["doorbellSettings"] # => %{"defaultMessageText" => "Welcome", ...}