matrix-org / matrix-org/matrix-spec

Support arbitrary metadata on invites (SPEC-357)

Open
#160 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server feature p2
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

A request from [~Rugvip] is to support the ability to include arbitrary metadata in invites, so that clients can perform business logic on the invite without having to accept it. The given example is:

let's say you're creating an online game on top of synapse, and you can invite users either to chat channels or to game lobbies
and if a room is a game lobby or not is determined by a key in the create state
You could of course do it with weird hacks in the room name, avatar, w/e
or what the hell, why not just make the invite state types configurable? :D
defaulting to the current ones

(Imported from https://matrix.org/jira/browse/SPEC-357)

(Reported by @ara4n)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the invite-state requirements in the Matrix specification and the imported SPEC-357 request first. Clarify the metadata format, scope, compatibility requirements, and affected specification sections; done means the proposal is specified precisely enough for clients to use and the required specification updates are complete.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.