Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
executable file 74 lines (59 sloc) 2.64 KB

Patter Room Settings

net.patter-app.settings

Patter rooms are of type net.patter-app.room and should always include this settings annotation to provide additional information about the room and how it should be displayed.

Examples

{
    "type":"net.patter-app.room",
    "annotations":[
      {
        "type":"net.patter-app.settings",
        "value":{
          "categories":[
            "tech"
          ],
          "name":"Welcome to Patter",
          "blurb":"A room for new users. Feel free to ask questions and try things out.",
          "blurb_id":"30951"
        }
      },
      {
        "type":"net.app.core.fallback_url",
        "value":{
          "url":"http:\/\/patter-app.net\/room.html?channel=964"
        }
      }
    ]
  }
}

Fields

Field Required? Type Description
name Required string User-facing name for the room. Need not be unique.
blurb Optional string User description of the room.
categories Optional list of strings Zero or more identifiers categorizing the room (see below).
blurb_id Optional string Message id of channel invite to the room.

Notes

The blurb, categories, and blurb_id fields are mostly used when a user wishes to invite others to the room. A publicly-promoted room should have both a blurb and a blurb_id.

The blurb_id indicates a net.app.core.channel.invite message posted to channel 1614. When a user wishes to remove their channel from promotion, that message should be removed and the blurb, categories, and blurb_id fields should be removed from the channel annotation.

categories is a list of identifiers. The following identifiers are recognized by patter-app.net: 'fun', 'lifestyle', 'profession', 'language', 'community', 'tech', 'event'. If a channel does not have a recognized category, it should be listed as a 'general' room.

Maintainers

Used by

Related annotations

net.patter-app.room net.app.core.channel.invite net.app.core.fallback_url