Document fields of oob_data
This commit is contained in:
parent
10b1b6443d
commit
7ae2c5b11b
1 changed files with 3 additions and 0 deletions
|
@ -63,6 +63,9 @@ module.exports = React.createClass({
|
||||||
// but has been passed out-of-band, eg. the room name and avatar URL
|
// but has been passed out-of-band, eg. the room name and avatar URL
|
||||||
// from an email invite (a workaround for the fact that we can't
|
// from an email invite (a workaround for the fact that we can't
|
||||||
// get this information from the HS using an email invite).
|
// get this information from the HS using an email invite).
|
||||||
|
// Fields:
|
||||||
|
// * name (string) The room's name
|
||||||
|
// * avatarUrl (string) The mxc:// avatar URL for the room
|
||||||
oobData: React.PropTypes.object,
|
oobData: React.PropTypes.object,
|
||||||
|
|
||||||
// id of an event to jump to. If not given, will go to the end of the
|
// id of an event to jump to. If not given, will go to the end of the
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue