Type alias UserEventHandlerMap

Type declaration

• User.avatarUrl: ((event: MatrixEvent | undefined, user: User) => void)

  • • (event: MatrixEvent | undefined, user: User): void

    • Fires whenever any user's avatar URL changes.

      Example

      matrixClient.on("User.avatarUrl", function(event, user){
        var newUrl = user.avatarUrl;
      });
      

      Parameters

      • event: MatrixEvent | undefined

        The matrix event which caused this event to fire.

      • user: User

        The user whose User.avatarUrl changed.

      Returns void

• User.currentlyActive: ((event: MatrixEvent | undefined, user: User) => void)

  • • (event: MatrixEvent | undefined, user: User): void

    • Fires whenever any user's currentlyActive changes.

      Example

      matrixClient.on("User.currentlyActive", function(event, user){
        var newCurrentlyActive = user.currentlyActive;
      });
      

      Parameters

      • event: MatrixEvent | undefined

        The matrix event which caused this event to fire.

      • user: User

        The user whose User.currentlyActive changed.

      Returns void

• User.displayName: ((event: MatrixEvent | undefined, user: User) => void)

  • • (event: MatrixEvent | undefined, user: User): void

    • Fires whenever any user's display name changes.

      Example

      matrixClient.on("User.displayName", function(event, user){
        var newName = user.displayName;
      });
      

      Parameters

      • event: MatrixEvent | undefined

        The matrix event which caused this event to fire.

      • user: User

        The user whose User.displayName changed.

      Returns void

• User.lastPresenceTs: ((event: MatrixEvent | undefined, user: User) => void)

  • • (event: MatrixEvent | undefined, user: User): void

    • Fires whenever any user's lastPresenceTs changes, ie. whenever any presence event is received for a user.

      Example

      matrixClient.on("User.lastPresenceTs", function(event, user){
        var newlastPresenceTs = user.lastPresenceTs;
      });
      

      Parameters

      • event: MatrixEvent | undefined

        The matrix event which caused this event to fire.

      • user: User

        The user whose User.lastPresenceTs changed.

      Returns void

• User.presence: ((event: MatrixEvent | undefined, user: User) => void)

  • • (event: MatrixEvent | undefined, user: User): void

    • Fires whenever any user's presence changes.

      Example

      matrixClient.on("User.presence", function(event, user){
        var newPresence = user.presence;
      });
      

      Parameters

      • event: MatrixEvent | undefined

        The matrix event which caused this event to fire.

      • user: User

        The user whose User.presence changed.

      Returns void