lib/lita/user.rb in lita-3.0.4 vs lib/lita/user.rb in lita-3.1.0

@@ -97,9 +97,16 @@
       @metadata = Util.stringify_keys(metadata)
       @name = @metadata["name"] || @id
       ensure_name_metadata_set
     end
 
+    # The name used to "mention" the user in a group chat.
+    # @return [String] The user's mention name.
+    # @since 3.1.0
+    def mention_name
+      metadata["mention_name"] || name
+    end
+
     # Saves the user record to Redis, overwriting an previous data for the
     # current ID and user name.
     # @return [void]
     def save
       mention_name = metadata[:mention_name] || metadata["mention_name"]