figbus/elm-urbit-api/3.0.0

NOTE: the latest version is 4.0.1

Urbit.Group

type Policy
= Invite { pending : List Atom }
| Open
{ banRanks :
{ galaxies : Ban
, stars : Ban
, planets : Ban
, moons : Ban
, comets : Ban
}
, banned : List Atom
}

Policy for a group.

  • Invite will set the group to be invite-only
    • The pending field is the set of ships to send invites to
  • Open will set the group to be generally open to the public
    • The banRanks field allows you to ban entire classes of ships. See https://urbit.org/docs/glossary/ship for the meanings of ship ranks.
    • The banned field allows you to ban specific ships
type Ban
= Banned
| Allowed

Banned or allowed.

{ url : String
, name : String
, policy : Policy
, title : String
, description : String
}
-> (Result Error () -> msg)
-> Cmd msg

Create a group via a spider thread.

{ url : String
, resource : Resource
}
-> (Result Error () -> msg)
-> Cmd msg

Delete a group via a spider thread.

{ url : String
, resource : Resource
}
-> (Result Error () -> msg)
-> Cmd msg

Leave a group via a spider thread.

{ url : String
, resource : Resource
, ships : List Atom
, description : String
}
-> (Result Error () -> msg)
-> Cmd msg

Send invites to a group via a spider thread.