Liking cljdoc? Tell your friends :D

scicloj.zulipdata.client

Zulip REST client for the Clojurians instance, using HTTP basic auth with an account email + API key. Credentials are read from ZULIP_EMAIL / ZULIP_API_KEY env vars, or from ~/.zuliprc.

Zulip REST client for the Clojurians instance, using HTTP basic
auth with an account email + API key. Credentials are read from
`ZULIP_EMAIL` / `ZULIP_API_KEY` env vars, or from `~/.zuliprc`.
raw docstring

api-getclj

(api-get path)
(api-get path query-params)

Authenticated GET against the Clojurians Zulip API. path is resolved relative to base-url; query-params is an optional map. Wraps the request in a small retry loop with longer waits between retries and a 90-second per-request timeout. Returns the JSON body parsed with keyword keys.

Authenticated GET against the Clojurians Zulip API. `path` is
resolved relative to `base-url`; `query-params` is an optional map.
Wraps the request in a small retry loop with longer waits between
retries and a 90-second per-request timeout. Returns the JSON body
parsed with keyword keys.
sourceraw docstring

base-urlclj

API root for the Clojurians Zulip instance. All api-get paths are resolved relative to this prefix.

API root for the Clojurians Zulip instance. All `api-get` paths are
resolved relative to this prefix.
sourceraw docstring

get-meclj

(get-me)

Full /users/me response for the authenticated account. Use whoami for a trimmed summary.

Full `/users/me` response for the authenticated account. Use
`whoami` for a trimmed summary.
sourceraw docstring

get-messagesclj

(get-messages
  {:keys [narrow anchor num-before num-after apply-markdown]
   :or {anchor "newest" num-before 100 num-after 0 apply-markdown false}})

Fetch messages matching a narrow. narrow is a vector of maps, e.g. [{:operator "channel" :operand "data-science"}]. anchor may be "newest", "oldest", "first_unread", or a message id. Returns up to num-before + num-after + 1 messages around the anchor.

Fetch messages matching a narrow. `narrow` is a vector of maps, e.g.
[{:operator "channel" :operand "data-science"}].
`anchor` may be "newest", "oldest", "first_unread", or a message id.
Returns up to `num-before + num-after + 1` messages around the anchor.
sourceraw docstring

get-streamsclj

(get-streams)

Full /streams response — every stream the authenticated user can see. Returns the raw Zulip API map; the stream entries live under :streams.

Full `/streams` response — every stream the authenticated user can
see. Returns the raw Zulip API map; the stream entries live under
`:streams`.
sourceraw docstring

whoamiclj

(whoami)

Calls /users/me and returns a short summary of the authenticated identity. Use this after configuring credentials to confirm everything works before running a pull.

Calls `/users/me` and returns a short summary of the authenticated
identity. Use this after configuring credentials to confirm
everything works before running a pull.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close