Hologram.Server.Broadcast (hologram v0.9.2)

Copy Markdown View Source

A single broadcast entry queued on Hologram.Server's broadcasts field.

except lists identities ({:instance, id}, {:session, id}, {:user, id}) that should not receive the broadcast. Empty list means no exclusions.

Summary

Types

identity()

@type identity() ::
  {:instance, String.t()}
  | {:session, String.t()}
  | {:user, integer() | String.t() | atom()}

t()

@type t() :: %Hologram.Server.Broadcast{
  action_name: atom(),
  channel: atom() | tuple(),
  except: [identity()],
  params: map()
}