BaileysEx.Feature.Newsletter (baileys_ex v0.1.0-alpha.8)

Copy Markdown View Source

Newsletter helpers mapped from Baileys' newsletter.ts.

Summary

Functions

admin_count(conn, newsletter_jid, opts \\ [])

Fetch admin counts.

change_owner(conn, newsletter_jid, new_owner_jid, opts \\ [])

Change the newsletter owner.

create(conn, name, description \\ nil, opts \\ [])

Create a newsletter via WMex.

delete(conn, newsletter_jid, opts \\ [])

Delete a newsletter via WMex.

demote(conn, newsletter_jid, user_jid, opts \\ [])

Demote a newsletter admin.

fetch_messages(conn, newsletter_jid, count, opts \\ [])

Fetch newsletter message history over the newsletter IQ transport.

follow(conn, newsletter_jid, opts \\ [])

Follow a newsletter.

metadata(conn, type, key, opts \\ [])

Fetch newsletter metadata by invite or JID.

mute(conn, newsletter_jid, opts \\ [])

Mute a newsletter.

react_message(conn, newsletter_jid, server_id, reaction \\ nil, opts \\ [])

Send a newsletter reaction or delete an existing reaction.

remove_picture(conn, newsletter_jid, opts \\ [])

Remove the newsletter picture.

subscribe_updates(conn, newsletter_jid, opts \\ [])

Subscribe to live newsletter updates over the newsletter IQ transport.

subscribers(conn, newsletter_jid, opts \\ [])

Fetch subscriber counts.

unfollow(conn, newsletter_jid, opts \\ [])

Unfollow a newsletter.

unmute(conn, newsletter_jid, opts \\ [])

Unmute a newsletter.

update(conn, newsletter_jid, updates, opts \\ [])

Update newsletter metadata via WMex.

update_description(conn, newsletter_jid, description, opts \\ [])

Update the newsletter description.

update_name(conn, newsletter_jid, name, opts \\ [])

Update the newsletter name.

update_picture(conn, newsletter_jid, content, opts \\ [])

Update the newsletter picture.

Functions

admin_count(conn, newsletter_jid, opts \\ [])

@spec admin_count(term(), String.t(), keyword()) ::
  {:ok, non_neg_integer()} | {:error, term()}

Fetch admin counts.

change_owner(conn, newsletter_jid, new_owner_jid, opts \\ [])

@spec change_owner(term(), String.t(), String.t(), keyword()) ::
  :ok | {:error, term()}

Change the newsletter owner.

create(conn, name, description \\ nil, opts \\ [])

@spec create(term(), String.t(), String.t() | nil, keyword()) ::
  {:ok, map()} | {:error, term()}

Create a newsletter via WMex.

delete(conn, newsletter_jid, opts \\ [])

@spec delete(term(), String.t(), keyword()) :: :ok | {:error, term()}

Delete a newsletter via WMex.

demote(conn, newsletter_jid, user_jid, opts \\ [])

@spec demote(term(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}

Demote a newsletter admin.

fetch_messages(conn, newsletter_jid, count, opts \\ [])

@spec fetch_messages(term(), String.t(), pos_integer(), keyword()) ::
  {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}

Fetch newsletter message history over the newsletter IQ transport.

follow(conn, newsletter_jid, opts \\ [])

@spec follow(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Follow a newsletter.

metadata(conn, type, key, opts \\ [])

@spec metadata(term(), :invite | :jid, String.t(), keyword()) ::
  {:ok, map() | nil} | {:error, term()}

Fetch newsletter metadata by invite or JID.

mute(conn, newsletter_jid, opts \\ [])

@spec mute(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Mute a newsletter.

react_message(conn, newsletter_jid, server_id, reaction \\ nil, opts \\ [])

@spec react_message(term(), String.t(), String.t(), String.t() | nil, keyword()) ::
  :ok | {:error, term()}

Send a newsletter reaction or delete an existing reaction.

remove_picture(conn, newsletter_jid, opts \\ [])

@spec remove_picture(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Remove the newsletter picture.

subscribe_updates(conn, newsletter_jid, opts \\ [])

@spec subscribe_updates(term(), String.t(), keyword()) ::
  {:ok, %{duration: String.t()} | nil} | {:error, term()}

Subscribe to live newsletter updates over the newsletter IQ transport.

subscribers(conn, newsletter_jid, opts \\ [])

@spec subscribers(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Fetch subscriber counts.

unfollow(conn, newsletter_jid, opts \\ [])

@spec unfollow(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Unfollow a newsletter.

unmute(conn, newsletter_jid, opts \\ [])

@spec unmute(term(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Unmute a newsletter.

update(conn, newsletter_jid, updates, opts \\ [])

@spec update(term(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}

Update newsletter metadata via WMex.

update_description(conn, newsletter_jid, description, opts \\ [])

@spec update_description(term(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Update the newsletter description.

update_name(conn, newsletter_jid, name, opts \\ [])

@spec update_name(term(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Update the newsletter name.

update_picture(conn, newsletter_jid, content, opts \\ [])

@spec update_picture(term(), String.t(), term(), keyword()) ::
  {:ok, map()} | {:error, term()}

Update the newsletter picture.