Class

MembershipEvent

MembershipEvent()

Represents an m.room.member state event

Constructor

# new MembershipEvent()

View Source models/events/MembershipEvent.ts, line 8

Classes

MembershipEvent

Members

# effectiveMembership

The user's effective membership.

View Source models/events/MembershipEvent.ts, line 44

# membership

The user's membership.

View Source models/events/MembershipEvent.ts, line 35

# membershipFor

The user ID the membership affects.

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

# ownMembership

True if the membership event targets the sender. False otherwise. This will typically by false for kicks and bans.

View Source models/events/MembershipEvent.ts, line 17

# reason

The reason why a user may have sent this membership.

View Source models/events/MembershipEvent.ts, line 23

Methods

# effectiveMembership() → {EffectiveMembership}

The user's effective membership.

View Source models/events/MembershipEvent.ts, line 110

Returns:

Type: EffectiveMembership

# membership() → {Membership}

The user's membership.

View Source models/events/MembershipEvent.ts, line 103

Returns:

Type: Membership

# membershipFor() → {string}

The user ID the membership affects.

View Source models/events/MembershipEvent.ts, line 96

Returns:

Type: string

# ownMembership() → {boolean}

True if the membership event targets the sender. False otherwise. This will typically by false for kicks and bans.

View Source models/events/MembershipEvent.ts, line 82

Returns:

Type: boolean

# reason() → {string|undefined}

The reason why a user may have sent this membership.

View Source models/events/MembershipEvent.ts, line 89

Returns:

Type: string | undefined