Collaboration for Phoenix: one engine for people and agents working together live, under every component on a page.
Start an instance in your supervision tree, after your PubSub:
{Issho,
name: MyApp.Issho,
pubsub: MyApp.PubSub,
endpoint: MyAppWeb.Endpoint,
policy: MyApp.Collaboration,
store: {MyApp.CollabStore, MyApp.Repo}}Options
:name(required): the instance's name, given to every call.:pubsub(required): your app'sPhoenix.PubSub.:policy(required): yourIssho.Policy, which authorizes every action and says what each document is.:endpointor:secret_key_base: to sign join tokens.:store:{module, context}, anIssho.Storefor documents.:registry::global(the default) or a module withname(instance, document_id), for the documents' authorities.:on_mention:{module, function}or a function of two arguments, called with the key of someone a comment mentions and the item of their inbox, to wake an agent that is away (Issho.Inbox).:presence: whether this instance startsIssho.Presence(true).:ttl: how long, in milliseconds, an unused document stays open (30 seconds).:awareness_interval: milliseconds between awareness frames (50).:awareness_max_bytes: the largest awareness state of a session, as JSON (64 KB).:max_document_bytes(16 MB),:max_message_bytes(1 MB) and:token_max_age(300 seconds).:stream_max_bytes(1 MB),:room_max_streams(32) and:stream_keep(five minutes, in milliseconds): the limits of the rooms' streams (Issho.Streams).
See the architecture guide for how the parts fit together.
Summary
Functions
The content of a document's revision, for a form that publishes exactly
what a person saw: the epoch and revision the browser posts.
Joins a room as an actor from Elixir (an agent, a job), as a browser
would. Gives an Issho.Participant. Options: :can (:write),
:on_behalf_of, :claims, :notify (the process that receives what
happens in the room, the caller unless given) and :events (whether it
receives the room's events too, Issho.Event: false).
Takes an actor out of a room now, on every node: its sessions end, and it receives nothing more. Your app calls it when it takes access away; the policy refuses the actor from then on.
Starts an instance. See the options above.
Commits operations to a document from your server (a job, an import),
through the same checks and authority as everyone else's. :author is
who made it: an actor (Issho.Actor, your user or an agent, as the
hook's :by gets it) or a key ("server" unless given, a service).
Functions
@spec content(atom(), String.t(), String.t(), non_neg_integer()) :: {:ok, term()} | {:error, term()}
The content of a document's revision, for a form that publishes exactly
what a person saw: the epoch and revision the browser posts.
Joins a room as an actor from Elixir (an agent, a job), as a browser
would. Gives an Issho.Participant. Options: :can (:write),
:on_behalf_of, :claims, :notify (the process that receives what
happens in the room, the caller unless given) and :events (whether it
receives the room's events too, Issho.Event: false).
@spec revoke(atom(), String.t(), Issho.Actor.t() | String.t()) :: :ok
Takes an actor out of a room now, on every node: its sessions end, and it receives nothing more. Your app calls it when it takes access away; the policy refuses the actor from then on.
@spec start_link(keyword()) :: Supervisor.on_start()
Starts an instance. See the options above.
Commits operations to a document from your server (a job, an import),
through the same checks and authority as everyone else's. :author is
who made it: an actor (Issho.Actor, your user or an agent, as the
hook's :by gets it) or a key ("server" unless given, a service).