Class

SpaceChildEvent

SpaceChildEvent()

Represents an m.space.child state event
Constructor

# new SpaceChildEvent()

View Source models/events/SpaceChildEvent.ts, line 7

Classes

SpaceChildEvent

Members

# entityRoomId

The room ID of the space or room this child represents.

View Source models/events/SpaceChildEvent.ts, line 14

# isActiveChild

Whether or not this child is "active" or valid. Inactive children are not considered part of a space.

View Source models/events/SpaceChildEvent.ts, line 21

# order

An optional short string to differentiate the rendering order of entities.
See:

View Source models/events/SpaceChildEvent.ts, line 36

# suggested

Whether or not the child is a suggested entity for users to join.

View Source models/events/SpaceChildEvent.ts, line 42

# viaServers

The servers the client should provide to the homeserver when trying to join the entity (room). May be empty or falsey to denote the child is inactive.

View Source models/events/SpaceChildEvent.ts, line 29

Methods

# entityRoomId() → {string}

The room ID of the space or room this child represents.

View Source models/events/SpaceChildEvent.ts, line 80

string

# isActiveChild() → {boolean}

Whether or not this child is "active" or valid. Inactive children are not considered part of a space.

View Source models/events/SpaceChildEvent.ts, line 88

boolean

# order() → {string}

An optional short string to differentiate the rendering order of entities.
See:

View Source models/events/SpaceChildEvent.ts, line 105

string

# suggested() → {boolean}

Whether or not the child is a suggested entity for users to join.

View Source models/events/SpaceChildEvent.ts, line 112

boolean

# viaServers() → {Array}

The servers the client should provide to the homeserver when trying to join the entity (room). May be empty or falsey to denote the child is inactive.

View Source models/events/SpaceChildEvent.ts, line 97

Array