UrbitEx v0.7.2

UrbitEx.API.Metadata (UrbitEx v0.7.2) View Source

Client API to interact with the metadata-store of your Urbit ship. Allows you to change the metadata of groups and channels you own or are admin of, as well as preview metadata of groups you don't belong to yet.

Link to this section Summary

Functions

await_preview()
edit(session, channel, group, resource, type, key, value)

Edits the Metadata of a group or channel. Takes a Session struct, a Channel struct, a group Resource struct, a channel Resource struct, a type (either :groups or :graph), the key to edit, and the value to set. Keys can be

preview(session, channel, resource)

Link to this section Functions

Link to this function

await_preview()

View Source
Link to this function

edit(session, channel, group, resource, type, key, value)

View Source

Edits the Metadata of a group or channel. Takes a Session struct, a Channel struct, a group Resource struct, a channel Resource struct, a type (either :groups or :graph), the key to edit, and the value to set. Keys can be:

  • title takes a string
  • description takes a string
  • color takes a hex code string
  • picture takes a url string
  • vip applied to a group: "member-metadata" or ""
  • vip applied to a group-feed : "host-feed" or "admin-feed" or ""
  • vip applied to a notebook: "reader-comments" or ""
  • preview true or false
Link to this function

preview(session, channel, resource)

View Source