View Source Glific.Flows.Broadcast (Glific v5.1.6)

@spec broadcast_contacts(
  atom() | %{:organization_id => non_neg_integer(), optional(any()) => any()},
  [Glific.Contacts.Contact.t()],
  map()
) :: :ok

We are using this function from the flows.

broadcast_flow_to_group(flow, group, default_results \\ %{})

@spec broadcast_flow_to_group(Glific.Flows.Flow.t(), Glific.Groups.Group.t(), map()) ::
  {:ok, Glific.Flows.MessageBroadcast.t()} | {:error, String.t()}

The one simple public interface to broadcast a group

broadcast_message_to_group(group_message, group, message_params, default_results \\ %{})

@spec broadcast_message_to_group(
  Glific.Messages.Message.t(),
  Glific.Groups.Group.t(),
  map(),
  map()
) ::
  {:ok, Glific.Flows.MessageBroadcast.t()} | {:error, String.t()}

The one simple public interface to broadcast a group

broadcast_stats(message_broadcast_id)

@spec broadcast_stats(non_neg_integer()) :: {:ok, map()}

Get broadcast stats for a flow

execute_broadcasts(org_id)

@spec execute_broadcasts(any()) :: :ok

The one simple public interface to execute a group broadcast for an organization

get_broadcast_contact_ids(message_broadcast)

@spec get_broadcast_contact_ids(Glific.Flows.MessageBroadcast.t()) :: list()

get_broadcast_contact_ids

mark_broadcast_completed(org_id)

@spec mark_broadcast_completed(non_neg_integer()) :: :ok

Mark all the processed flow broadcast as completed

process_broadcast_group(message_broadcast)

@spec process_broadcast_group(Glific.Flows.MessageBroadcast.t() | nil) :: :ok

Start a group broadcast for a giving broadcast struct

Settings View Source Glific.Flows.Broadcast (Glific v5.1.6)

Link to this section Summary

Functions

Link to this section Functions

broadcast_contacts(flow, contacts, default_results \\ %{})