Class: MatrixSdk::Room
Overview
A class for tracking the information about a room on Matrix
Direct Known Subclasses
Constant Summary
Constants included from Util::Tinycache
Instance Attribute Summary collapse
-
#client ⇒ Client
readonly
The client for the room.
-
#event_history_limit ⇒ Fixnum
The limit of events to keep in the event log.
-
#events ⇒ Object
readonly
Returns the value of attribute events.
-
#id ⇒ String
(also: #room_id)
readonly
The internal ID of the room.
- #on_account_data ⇒ Object readonly
- #on_ephemeral_event ⇒ Object readonly
- #on_event ⇒ Object readonly
- #on_state_event ⇒ Object readonly
Instance Method Summary collapse
- #account_data ⇒ Object
-
#add_alias(room_alias) ⇒ Boolean
Add an alias to the room.
-
#add_tag(tag, **data) ⇒ Object
Add a tag to the room.
-
#admin!(user, level: 100) ⇒ Object
Make a user an admin in the room.
-
#admin?(user, target_level: 100) ⇒ Boolean
Check if a user is an admin in the room.
-
#aliases(canonical_only: true) ⇒ Array[String]
Gets the room aliases.
-
#all_members(**params) ⇒ Array(User)
Get all members (member events) in the room.
-
#allow_guests=(allow_guests) ⇒ Object
Sets if guests are allowed in the room.
-
#avatar_url ⇒ String?
Gets the avatar url of the room - if any.
-
#avatar_url=(avatar_url) ⇒ Object
Sets a new avatar URL for the room.
-
#backfill_messages(*args, reverse: false, limit: 10) ⇒ Object
Backfills messages into the room history.
-
#ban_user(user_id, reason = '') ⇒ Boolean
Bans a user from the room.
-
#canonical_alias ⇒ String?
The canonical alias of the room.
-
#creation_info ⇒ Response
Gets the room creation information.
-
#display_name ⇒ String
Gets a human-readable name for the room.
-
#dm=(direct) ⇒ Object
Mark a room as a direct (1:1) message Room.
-
#dm?(members_only: false) ⇒ Boolean
Checks if the room is a direct message / 1:1 room.
-
#get_account_data(type) ⇒ Hash
Retrieves a custom entry from the room-specific account data.
-
#get_state(type, state_key: nil) ⇒ Object
Gets a state object in the room.
-
#guest_access ⇒ :can_join, :forbidden
Gets the guest access rights for the room.
-
#guest_access=(guest_access) ⇒ Object
Sets the guest access status for the room.
-
#guest_access? ⇒ Boolean
Checks if
guest_access
is set to:can_join
. -
#history_visibility ⇒ :invited, ...
Gets the history visibility of the room.
-
#initialize(client, room_id, data = {}) ⇒ Room
constructor
Create a new room instance.
-
#inspect ⇒ String
An inspect method that skips a handful of instance variables to avoid flooding the terminal with debug data.
-
#invite_only=(invite_only) ⇒ Object
Sets if the room should be invite only or not.
-
#invite_only? ⇒ Boolean
Checks if
join_rule
is set to:invite
. -
#invite_user(user_id) ⇒ Boolean
Invites a user into the room.
-
#join_rule ⇒ :public, ...
Gets the join rule for the room.
-
#join_rule=(join_rule) ⇒ Object
Sets the join rule of the room.
-
#joined_members ⇒ Array(User)
Populates and returns the #members array.
-
#kick_user(user_id, reason = '') ⇒ Boolean
Kicks a user from the room.
-
#knock_only? ⇒ Boolean
Checks if
join_rule
is set to:knock
. -
#leave ⇒ Boolean
Requests to be removed from the room.
- #members ⇒ Object
-
#moderator!(user, level: 50) ⇒ Object
Make a user a moderator in the room.
-
#moderator?(user, target_level: 50) ⇒ Boolean
Check if a user is a moderator in the room.
-
#modify_required_power_levels(events = nil, params = {}) ⇒ Boolean
Modifies the required power levels for actions in the room.
-
#modify_user_power_levels(users = nil, users_default = nil) ⇒ Boolean
Modifies the power levels of the room.
-
#name ⇒ String?
Gets the current name of the room, querying the API if necessary.
-
#name=(name) ⇒ Object
Sets a new name on the room.
-
#power_levels ⇒ Hash
Get the power levels of the room.
-
#redact_message(event_id, reason = nil) ⇒ Object
Redacts a message from the room.
-
#reload! ⇒ Object
(also: #refresh!)
Refreshes the room state caches for name, topic, and aliases.
-
#reload_aliases! ⇒ Boolean
(also: #refresh_aliases!)
Reloads the list of aliases by an API query.
-
#reload_name! ⇒ Boolean
(also: #refresh_name!)
Reloads the name of the room.
-
#reload_topic! ⇒ Boolean
(also: #refresh_topic!)
Reloads the topic of the room.
-
#remove_tag(tag) ⇒ Object
Remove a tag from the room.
-
#report_message(event_id, reason:, score: -100)) ⇒ Object
Reports a message in the room.
- #room_state ⇒ Object
-
#room_type ⇒ 'm.space', ...
Retrieves the type of the room.
-
#room_version ⇒ String
Retrieves the room version.
-
#send_audio(url, name, audio_info = {}) ⇒ Object
Sends a link to an audio clip to the room.
-
#send_custom_message(body, content = {}, msgtype: nil) ⇒ Object
Sends a customized message to the Room.
-
#send_emote(text) ⇒ Object
Sends an emote (/me) message to the room.
-
#send_event(type, content = {}) ⇒ Object
Sends a custom timeline event to the Room.
-
#send_file(url, name, file_info = {}) ⇒ Object
Sends a link to a generic file to the room.
-
#send_html(html, body = nil, msgtype: nil, format: nil) ⇒ Object
Sends a custom HTML message to the room.
-
#send_image(url, name, image_info = {}) ⇒ Object
Sends a link to an image to the room.
-
#send_location(geo_uri, name, thumbnail_url = nil, thumbnail_info = {}) ⇒ Object
Sends a location object to the room.
-
#send_notice(text) ⇒ Object
Sends a notice (bot) message to the room.
-
#send_text(text) ⇒ Object
Sends a plain-text message to the room.
-
#send_video(url, name, video_info = {}) ⇒ Object
Sends a link to a video to the room.
-
#set_account_data(type, account_data) ⇒ Object
Stores a custom entry into the room-specific account data.
-
#set_state(type, data, state_key: nil) ⇒ Object
Sets a state object in the room.
-
#set_user_profile(display_name: nil, avatar_url: nil, reason: nil) ⇒ Object
Changes the room-specific user profile.
-
#space? ⇒ Boolean?
Checks if the room is a Matrix Space.
-
#tags ⇒ Response
Returns a list of the room tags.
- #to_s ⇒ Object
-
#to_space ⇒ Object
Casting operators.
-
#topic ⇒ String?
Gets the room topic - if any.
-
#topic=(topic) ⇒ Object
Sets a new topic on the room.
-
#unban_user(user_id) ⇒ Boolean
Unbans a user from the room.
-
#user_can_send?(user, event, state: false) ⇒ Boolean
Checks if a user can send a given event type in the room.
-
#user_powerlevel(user, use_default: true) ⇒ Integer?
Gets the power level of a user in the room.
-
#world_readable? ⇒ Boolean
(also: #world_readable)
Checks if the room history is world readable.
Methods included from Extensions
Methods included from Util::Tinycache
adapter, adapter=, cached, extended, tinycache_adapter_config
Methods included from Logging
Constructor Details
#initialize(client, room_id, data = {}) ⇒ Room
This method isn’t supposed to be used directly, rather rooms should be retrieved from the Client abstraction.
Create a new room instance
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/matrix_sdk/room.rb', line 64 def initialize(client, room_id, data = {}) if client.is_a? Room copy = client client = copy.client room_id = copy.id # data = copy.attributes end raise ArgumentError, 'Must be given a Client instance' unless client.is_a? Client @client = client room_id = MXID.new room_id unless room_id.is_a?(MXID) raise ArgumentError, 'room_id must be a valid Room ID' unless room_id.room_id? @events = [] @event_history_limit = 10 @room_type = nil @prev_batch = nil %i[name topic canonical_alias avatar_url].each do |type| room_state.tinycache_adapter.write("m.room.#{type}", { type => data.delete(type) }) if data.key? type end room_state.tinycache_adapter.write('m.room.join_rules', { join_rule: data.delete(:join_rule) }) if data.key? :join_rule room_state.tinycache_adapter.write('m.room.history_visibility', { history_visibility: data.delete(:world_readable) ? :world_readable : nil }) if data.key? :world_readable data.each do |k, v| next if %i[client].include? k if respond_to?("#{k}_cached?".to_sym) && send("#{k}_cached?".to_sym) tinycache_adapter.write(k, v) elsif instance_variable_defined? "@#{k}" instance_variable_set("@#{k}", v) end end @id = room_id.to_s logger.debug "Created room #{room_id}" end |
Instance Attribute Details
#client ⇒ Client (readonly)
Returns the client for the room.
25 |
# File 'lib/matrix_sdk/room.rb', line 25 attr_reader :id, :client, :events |
#event_history_limit ⇒ Fixnum
Returns the limit of events to keep in the event log.
16 17 18 |
# File 'lib/matrix_sdk/room.rb', line 16 def event_history_limit @event_history_limit end |
#events ⇒ Object (readonly)
Returns the value of attribute events.
25 |
# File 'lib/matrix_sdk/room.rb', line 25 attr_reader :id, :client, :events |
#id ⇒ String (readonly) Also known as: room_id
Returns the internal ID of the room.
25 26 27 |
# File 'lib/matrix_sdk/room.rb', line 25 def id @id end |
#on_account_data ⇒ Object (readonly)
135 136 137 |
# File 'lib/matrix_sdk/room.rb', line 135 def on_account_data ensure_room_handlers[:account_data] end |
#on_ephemeral_event ⇒ Object (readonly)
147 148 149 |
# File 'lib/matrix_sdk/room.rb', line 147 def on_ephemeral_event ensure_room_handlers[:ephemeral_event] end |
#on_event ⇒ Object (readonly)
129 130 131 |
# File 'lib/matrix_sdk/room.rb', line 129 def on_event ensure_room_handlers[:event] end |
#on_state_event ⇒ Object (readonly)
141 142 143 |
# File 'lib/matrix_sdk/room.rb', line 141 def on_state_event ensure_room_handlers[:state_event] end |
Instance Method Details
#account_data ⇒ Object
575 576 577 578 579 |
# File 'lib/matrix_sdk/room.rb', line 575 def account_data return MatrixSdk::Util::AccountDataCache.new client, room: self if client.cache == :none @account_data ||= MatrixSdk::Util::AccountDataCache.new client, room: self end |
#add_alias(room_alias) ⇒ Boolean
Add an alias to the room
741 742 743 744 745 |
# File 'lib/matrix_sdk/room.rb', line 741 def add_alias(room_alias) client.api.set_room_alias(id, room_alias) tinycache_adapter.read(:aliases) << room_alias if tinycache_adapter.exist?(:aliases) true end |
#add_tag(tag, **data) ⇒ Object
Add a tag to the room
688 689 690 691 |
# File 'lib/matrix_sdk/room.rb', line 688 def add_tag(tag, **data) client.api.add_user_tag(client.mxid, id, tag, data) true end |
#admin!(user, level: 100) ⇒ Object
Make a user an admin in the room
858 859 860 861 862 863 864 865 866 |
# File 'lib/matrix_sdk/room.rb', line 858 def admin!(user, level: 100) return true if admin?(user, target_level: level) user = user.id if user.is_a? User user = MXID.new(user.to_s) unless user.is_a? MXID raise ArgumentError, 'Must provide a valid user or MXID' unless user.user? modify_user_power_levels({ user.to_s.to_sym => level }) end |
#admin?(user, target_level: 100) ⇒ Boolean
Check if a user is an admin in the room
846 847 848 849 850 851 |
# File 'lib/matrix_sdk/room.rb', line 846 def admin?(user, target_level: 100) level = user_powerlevel(user, use_default: false) return false unless level level >= target_level end |
#aliases(canonical_only: true) ⇒ Array[String]
Gets the room aliases
330 331 332 333 334 335 336 |
# File 'lib/matrix_sdk/room.rb', line 330 def aliases(canonical_only: true) canonical = get_state('m.room.canonical_alias') rescue {} aliases = ([canonical[:alias]].compact + (canonical[:alt_aliases] || [])).uniq.sort return aliases if canonical_only (aliases + client.api.get_room_aliases(id).aliases).uniq.sort end |
#all_members(**params) ⇒ Array(User)
This will also count members who’ve knocked, been invited, have left, or have been banned.
Get all members (member events) in the room
204 205 206 |
# File 'lib/matrix_sdk/room.rb', line 204 def all_members(**params) client.api.get_room_members(id, **params)[:chunk].map { |ch| client.get_user(ch[:state_key]) } end |
#allow_guests=(allow_guests) ⇒ Object
Sets if guests are allowed in the room
777 778 779 780 |
# File 'lib/matrix_sdk/room.rb', line 777 def allow_guests=(allow_guests) self.guest_access = (allow_guests ? :can_join : :forbidden) allow_guests end |
#avatar_url ⇒ String?
Gets the avatar url of the room - if any
249 250 251 252 253 254 |
# File 'lib/matrix_sdk/room.rb', line 249 def avatar_url get_state('m.room.avatar_url')[:url] rescue MatrixNotFoundError # No avatar has been set nil end |
#avatar_url=(avatar_url) ⇒ Object
Sets a new avatar URL for the room
793 794 795 796 797 798 799 |
# File 'lib/matrix_sdk/room.rb', line 793 def avatar_url=(avatar_url) avatar_url = URI(avatar_url) unless avatar_url.is_a? URI raise ArgumentError, 'Must be a valid MXC URL' unless avatar_url.is_a? URI::MXC room_state['m.room.avatar_url'] = { avatar_url: avatar_url } avatar_url end |
#backfill_messages(*args, reverse: false, limit: 10) ⇒ Object
This will trigger the ‘on_event` events as messages are added
Backfills messages into the room history
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
# File 'lib/matrix_sdk/room.rb', line 503 def (*args, reverse: false, limit: 10) # To be backwards-compatible if args.length == 2 reverse = args.first limit = args.last end data = client.api.(id, @prev_batch, direction: :b, limit: limit) events = data[:chunk] events.reverse! unless reverse events.each do |ev| put_event(ev) end true end |
#ban_user(user_id, reason = '') ⇒ Boolean
Bans a user from the room
550 551 552 553 554 |
# File 'lib/matrix_sdk/room.rb', line 550 def ban_user(user_id, reason = '') user_id = user_id.id if user_id.is_a? MatrixSdk::User client.api.ban_user(id, user_id, reason: reason) true end |
#canonical_alias ⇒ String?
Returns the canonical alias of the room.
180 181 182 183 184 |
# File 'lib/matrix_sdk/room.rb', line 180 def canonical_alias get_state('m.room.canonical_alias')[:alias] rescue MatrixSdk::MatrixNotFoundError nil end |
#creation_info ⇒ Response
Gets the room creation information
619 620 621 |
# File 'lib/matrix_sdk/room.rb', line 619 def creation_info room_state['m.room.create'] end |
#display_name ⇒ String
This method will populate the #members list if it has to fall back to the member name generation.
Gets a human-readable name for the room
This will return #name or #canonical_alias if they’ve been set, otherwise it will query the API for members and generate a string from a subset of their names.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/matrix_sdk/room.rb', line 164 def display_name return name if name return canonical_alias if canonical_alias members = joined_members .reject { |m| m.user_id == client.mxid } .map(&:display_name) return members.first if members.one? return "#{members.first} and #{members.last}" if members.count == 2 return "#{members.first} and #{members.count - 1} others" if members.count > 2 'Empty Room' end |
#dm=(direct) ⇒ Object
Mark a room as a direct (1:1) message Room
231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/matrix_sdk/room.rb', line 231 def dm=(direct) rooms = client.direct_rooms dirty = false list_for_room = (rooms[id.to_s] ||= []) if direct && !list_for_room.include?(id.to_s) list_for_room << id.to_s dirty = true elsif !direct && list_for_room.include?(id.to_s) list_for_room.delete id.to_s rooms.delete id.to_s if list_for_room.empty? dirty = true end client.account_data['m.direct'] = rooms if dirty end |
#dm?(members_only: false) ⇒ Boolean
Checks if the room is a direct message / 1:1 room
224 225 226 227 228 |
# File 'lib/matrix_sdk/room.rb', line 224 def dm?(members_only: false) return true if !members_only && client.direct_rooms.any? { |_uid, rooms| rooms.include? id.to_s } joined_members.count <= 2 end |
#get_account_data(type) ⇒ Hash
Retrieves a custom entry from the room-specific account data
585 586 587 |
# File 'lib/matrix_sdk/room.rb', line 585 def get_account_data(type) account_data[type] end |
#get_state(type, state_key: nil) ⇒ Object
Gets a state object in the room
302 303 304 |
# File 'lib/matrix_sdk/room.rb', line 302 def get_state(type, state_key: nil) room_state[type, state_key] end |
#guest_access ⇒ :can_join, :forbidden
Gets the guest access rights for the room
269 270 271 |
# File 'lib/matrix_sdk/room.rb', line 269 def guest_access get_state('m.room.guest_access')[:guest_access]&.to_sym end |
#guest_access=(guest_access) ⇒ Object
Sets the guest access status for the room
785 786 787 788 |
# File 'lib/matrix_sdk/room.rb', line 785 def guest_access=(guest_access) room_state['m.room.guest_access'] = { guest_access: guest_access } guest_access end |
#guest_access? ⇒ Boolean
Checks if guest_access
is set to :can_join
281 282 283 |
# File 'lib/matrix_sdk/room.rb', line 281 def guest_access? guest_access == :can_join end |
#history_visibility ⇒ :invited, ...
Gets the history visibility of the room
314 315 316 |
# File 'lib/matrix_sdk/room.rb', line 314 def history_visibility get_state('m.room.history_visibility')[:history_visibility]&.to_sym end |
#inspect ⇒ String
An inspect method that skips a handful of instance variables to avoid flooding the terminal with debug data.
31 |
# File 'lib/matrix_sdk/room.rb', line 31 ignore_inspect :client, :events, :prev_batch, :logger, :tinycache_adapter |
#invite_only=(invite_only) ⇒ Object
Sets if the room should be invite only or not
761 762 763 764 |
# File 'lib/matrix_sdk/room.rb', line 761 def invite_only=(invite_only) self.join_rule = invite_only ? :invite : :public invite_only end |
#invite_only? ⇒ Boolean
Checks if join_rule
is set to :invite
286 287 288 |
# File 'lib/matrix_sdk/room.rb', line 286 def invite_only? join_rule == :invite end |
#invite_user(user_id) ⇒ Boolean
Invites a user into the room
528 529 530 531 532 |
# File 'lib/matrix_sdk/room.rb', line 528 def invite_user(user_id) user_id = user_id.id if user_id.is_a? MatrixSdk::User client.api.invite_user(id, user_id) true end |
#join_rule ⇒ :public, ...
Gets the join rule for the room
276 277 278 |
# File 'lib/matrix_sdk/room.rb', line 276 def join_rule get_state('m.room.join_rules')[:join_rule]&.to_sym end |
#join_rule=(join_rule) ⇒ Object
Sets the join rule of the room
769 770 771 772 |
# File 'lib/matrix_sdk/room.rb', line 769 def join_rule=(join_rule) room_state['m.room.join_rules'] = { join_rule: join_rule } join_rule end |
#joined_members ⇒ Array(User)
Populates and returns the #members array
189 190 191 192 193 194 195 |
# File 'lib/matrix_sdk/room.rb', line 189 def joined_members client.api.get_room_joined_members(id)[:joined].map do |mxid, data| User.new(client, mxid.to_s, display_name: data.fetch(:display_name, nil), avatar_url: data.fetch(:avatar_url, nil)) end end |
#kick_user(user_id, reason = '') ⇒ Boolean
Kicks a user from the room
539 540 541 542 543 |
# File 'lib/matrix_sdk/room.rb', line 539 def kick_user(user_id, reason = '') user_id = user_id.id if user_id.is_a? MatrixSdk::User client.api.kick_user(id, user_id, reason: reason) true end |
#knock_only? ⇒ Boolean
Checks if join_rule
is set to :knock
291 292 293 |
# File 'lib/matrix_sdk/room.rb', line 291 def knock_only? join_rule == :knock end |
#leave ⇒ Boolean
Requests to be removed from the room
569 570 571 572 573 |
# File 'lib/matrix_sdk/room.rb', line 569 def leave client.api.leave_room(id) client.instance_variable_get(:@rooms).delete id true end |
#members ⇒ Object
41 |
# File 'lib/matrix_sdk/room.rb', line 41 alias members joined_members |
#moderator!(user, level: 50) ⇒ Object
Make a user a moderator in the room
886 887 888 889 890 891 892 893 894 |
# File 'lib/matrix_sdk/room.rb', line 886 def moderator!(user, level: 50) return true if moderator?(user, target_level: level) user = user.id if user.is_a? User user = MXID.new(user.to_s) unless user.is_a? MXID raise ArgumentError, 'Must provide a valid user or MXID' unless user.user? modify_user_power_levels({ user.to_s.to_sym => level }) end |
#moderator?(user, target_level: 50) ⇒ Boolean
Check if a user is a moderator in the room
874 875 876 877 878 879 |
# File 'lib/matrix_sdk/room.rb', line 874 def moderator?(user, target_level: 50) level = user_powerlevel(user, use_default: false) return false unless level level >= target_level end |
#modify_required_power_levels(events = nil, params = {}) ⇒ Boolean
Modifies the required power levels for actions in the room
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 |
# File 'lib/matrix_sdk/room.rb', line 933 def modify_required_power_levels(events = nil, params = {}) return false if events.nil? && (params.nil? || params.empty?) room_state.tinycache_adapter.expire 'm.room.power_levels' data = power_levels data.merge!(params) data.delete_if { |_k, v| v.nil? } if events data[:events] = {} unless data.key? :events data[:events].merge!(events) data[:events].delete_if { |_k, v| v.nil? } end room_state['m.room.power_levels'] = data true end |
#modify_user_power_levels(users = nil, users_default = nil) ⇒ Boolean
Modifies the power levels of the room
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 |
# File 'lib/matrix_sdk/room.rb', line 901 def modify_user_power_levels(users = nil, users_default = nil) return false if users.nil? && users_default.nil? room_state.tinycache_adapter.expire 'm.room.power_levels' data = power_levels data[:users_default] = users_default unless users_default.nil? if users data[:users] = {} unless data.key? :users users.each do |user, level| user = user.id if user.is_a? User user = MXID.new(user.to_s) unless user.is_a? MXID raise ArgumentError, 'Must provide a valid user or MXID' unless user.user? if level.nil? data[:users].delete(user.to_s.to_sym) else data[:users][user.to_s.to_sym] = level end end end room_state['m.room.power_levels'] = data true end |
#name ⇒ String?
Will cache the current name for 15 minutes
Gets the current name of the room, querying the API if necessary
213 214 215 216 217 218 |
# File 'lib/matrix_sdk/room.rb', line 213 def name get_state('m.room.name')[:name] rescue MatrixNotFoundError # No room name has been specified nil end |
#name=(name) ⇒ Object
Sets a new name on the room
709 710 711 712 |
# File 'lib/matrix_sdk/room.rb', line 709 def name=(name) room_state['m.room.name'] = { name: name } name end |
#power_levels ⇒ Hash
The returned power levels are cached for a minute
Get the power levels of the room
806 807 808 |
# File 'lib/matrix_sdk/room.rb', line 806 def power_levels get_state('m.room.power_levels') end |
#redact_message(event_id, reason = nil) ⇒ Object
Redacts a message from the room
483 484 485 486 |
# File 'lib/matrix_sdk/room.rb', line 483 def (event_id, reason = nil) client.api.redact_event(id, event_id, reason: reason) true end |
#reload! ⇒ Object Also known as: refresh!
Refreshes the room state caches for name, topic, and aliases
698 699 700 701 702 703 |
# File 'lib/matrix_sdk/room.rb', line 698 def reload! reload_name! reload_topic! reload_aliases! true end |
#reload_aliases! ⇒ Boolean Also known as: refresh_aliases!
The list of aliases is not sorted, ordering changes will result in alias list updates.
Reloads the list of aliases by an API query
752 753 754 755 |
# File 'lib/matrix_sdk/room.rb', line 752 def reload_aliases! room_state.expire('m.room.canonical_alias') clear_aliases_cache end |
#reload_name! ⇒ Boolean Also known as: refresh_name!
Reloads the name of the room
717 718 719 |
# File 'lib/matrix_sdk/room.rb', line 717 def reload_name! room_state.expire('m.room.name') end |
#reload_topic! ⇒ Boolean Also known as: refresh_topic!
Reloads the topic of the room
733 734 735 |
# File 'lib/matrix_sdk/room.rb', line 733 def reload_topic! room_state.expire('m.room.topic') end |
#remove_tag(tag) ⇒ Object
Remove a tag from the room
679 680 681 682 |
# File 'lib/matrix_sdk/room.rb', line 679 def remove_tag(tag) client.api.remove_user_tag(client.mxid, id, tag) true end |
#report_message(event_id, reason:, score: -100)) ⇒ Object
Reports a message in the room
493 494 495 496 |
# File 'lib/matrix_sdk/room.rb', line 493 def (event_id, reason:, score: -100) client.api.report_event(id, event_id, reason: reason, score: score) true end |
#room_state ⇒ Object
295 296 297 298 299 |
# File 'lib/matrix_sdk/room.rb', line 295 def room_state return MatrixSdk::Util::StateEventCache.new self if client.cache == :none @room_state ||= MatrixSdk::Util::StateEventCache.new self end |
#room_type ⇒ 'm.space', ...
Retrieves the type of the room
626 627 628 629 |
# File 'lib/matrix_sdk/room.rb', line 626 def room_type # Can't change, so a permanent cache is ok @room_type ||= creation_info[:type] end |
#room_version ⇒ String
Retrieves the room version
634 635 636 637 |
# File 'lib/matrix_sdk/room.rb', line 634 def room_version # Can't change, so a permanent cache is ok @room_version ||= creation_info[:room_version] end |
#send_audio(url, name, audio_info = {}) ⇒ Object
The URLs should all be of the ‘mxc://’ schema
Sends a link to an audio clip to the room
450 451 452 |
# File 'lib/matrix_sdk/room.rb', line 450 def send_audio(url, name, audio_info = {}) client.api.send_content(id, url, name, 'm.audio', extra_information: audio_info) end |
#send_custom_message(body, content = {}, msgtype: nil) ⇒ Object
Sends a customized message to the Room
459 460 461 462 463 464 465 466 |
# File 'lib/matrix_sdk/room.rb', line 459 def (body, content = {}, msgtype: nil) content.merge!( body: body, msgtype: msgtype || 'm.text' ) client.api.(id, 'm.room.message', content) end |
#send_emote(text) ⇒ Object
Sends an emote (/me) message to the room
372 373 374 |
# File 'lib/matrix_sdk/room.rb', line 372 def send_emote(text) client.api.send_emote(id, text) end |
#send_event(type, content = {}) ⇒ Object
Sends a custom timeline event to the Room
475 476 477 |
# File 'lib/matrix_sdk/room.rb', line 475 def send_event(type, content = {}) client.api.(id, type, content) end |
#send_file(url, name, file_info = {}) ⇒ Object
The URLs should all be of the ‘mxc://’ schema
Sends a link to a generic file to the room
386 387 388 |
# File 'lib/matrix_sdk/room.rb', line 386 def send_file(url, name, file_info = {}) client.api.send_content(id, url, name, 'm.file', extra_information: file_info) end |
#send_html(html, body = nil, msgtype: nil, format: nil) ⇒ Object
Sends a custom HTML message to the room
358 359 360 361 362 363 364 365 366 367 |
# File 'lib/matrix_sdk/room.rb', line 358 def send_html(html, body = nil, msgtype: nil, format: nil) content = { body: body || html.gsub(/<\/?[^>]*>/, ''), msgtype: msgtype || 'm.text', format: format || 'org.matrix.custom.html', formatted_body: html } client.api.(id, 'm.room.message', content) end |
#send_image(url, name, image_info = {}) ⇒ Object
The URLs should all be of the ‘mxc://’ schema
Sends a link to an image to the room
409 410 411 |
# File 'lib/matrix_sdk/room.rb', line 409 def send_image(url, name, image_info = {}) client.api.send_content(id, url, name, 'm.image', extra_information: image_info) end |
#send_location(geo_uri, name, thumbnail_url = nil, thumbnail_info = {}) ⇒ Object
The thumbnail URL should be of the ‘mxc://’ schema
Sends a location object to the room
420 421 422 |
# File 'lib/matrix_sdk/room.rb', line 420 def send_location(geo_uri, name, thumbnail_url = nil, thumbnail_info = {}) client.api.send_location(id, geo_uri, name, thumbnail_url: thumbnail_url, thumbnail_info: thumbnail_info) end |
#send_notice(text) ⇒ Object
Sends a notice (bot) message to the room
393 394 395 |
# File 'lib/matrix_sdk/room.rb', line 393 def send_notice(text) client.api.send_notice(id, text) end |
#send_text(text) ⇒ Object
Sends a plain-text message to the room
345 346 347 |
# File 'lib/matrix_sdk/room.rb', line 345 def send_text(text) client.api.(id, text) end |
#send_video(url, name, video_info = {}) ⇒ Object
The URLs should all be of the ‘mxc://’ schema
Sends a link to a video to the room
437 438 439 |
# File 'lib/matrix_sdk/room.rb', line 437 def send_video(url, name, video_info = {}) client.api.send_content(id, url, name, 'm.video', extra_information: video_info) end |
#set_account_data(type, account_data) ⇒ Object
Stores a custom entry into the room-specific account data
593 594 595 596 |
# File 'lib/matrix_sdk/room.rb', line 593 def set_account_data(type, account_data) self.account_data[type] = account_data true end |
#set_state(type, data, state_key: nil) ⇒ Object
Sets a state object in the room
307 308 309 |
# File 'lib/matrix_sdk/room.rb', line 307 def set_state(type, data, state_key: nil) room_state[type, state_key] = data end |
#set_user_profile(display_name: nil, avatar_url: nil, reason: nil) ⇒ Object
the avatar URL should be a mxc:// URI
Changes the room-specific user profile
603 604 605 606 607 608 609 610 611 612 613 614 |
# File 'lib/matrix_sdk/room.rb', line 603 def set_user_profile(display_name: nil, avatar_url: nil, reason: nil) return nil unless display_name || avatar_url data = client.api.get_membership(id, client.mxid) raise "Can't set profile if you haven't joined the room" unless data[:membership] == 'join' data[:displayname] = display_name unless display_name.nil? data[:avatar_url] = avatar_url unless avatar_url.nil? client.api.set_membership(id, client.mxid, 'join', reason || 'Updating room profile information', data) true end |
#space? ⇒ Boolean?
Checks if the room is a Matrix Space
642 643 644 645 646 |
# File 'lib/matrix_sdk/room.rb', line 642 def space? room_type == 'm.space' rescue MatrixSdk::MatrixForbiddenError, MatrixSdk::MatrixNotFoundError nil end |
#tags ⇒ Response
Returns a list of the room tags
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 |
# File 'lib/matrix_sdk/room.rb', line 658 def client.api.(client.mxid, id)[:tags].tap do |tag_obj| tag_obj.instance_variable_set(:@room, self) tag_obj.define_singleton_method(:room) do @room end tag_obj.define_singleton_method(:add) do |tag, **data| @room.add_tag(tag.to_s.to_sym, **data) self[tag.to_s.to_sym] = data self end tag_obj.define_singleton_method(:remove) do |tag| @room.remove_tag(tag.to_s.to_sym) delete tag.to_s.to_sym end end end |
#to_s ⇒ Object
115 116 117 118 119 120 121 |
# File 'lib/matrix_sdk/room.rb', line 115 def to_s prefix = canonical_alias if canonical_alias_has_value? prefix ||= id return "#{prefix} | #{name}" if name_has_value? prefix end |
#to_space ⇒ Object
Casting operators
109 110 111 112 113 |
# File 'lib/matrix_sdk/room.rb', line 109 def to_space return nil unless space? Rooms::Space.new self, nil end |
#topic ⇒ String?
Gets the room topic - if any
259 260 261 262 263 264 |
# File 'lib/matrix_sdk/room.rb', line 259 def topic get_state('m.room.topic')[:topic] rescue MatrixNotFoundError # No room name has been specified nil end |
#topic=(topic) ⇒ Object
Sets a new topic on the room
725 726 727 728 |
# File 'lib/matrix_sdk/room.rb', line 725 def topic=(topic) room_state['m.room.topic'] = { topic: topic } topic end |
#unban_user(user_id) ⇒ Boolean
Unbans a user from the room
560 561 562 563 564 |
# File 'lib/matrix_sdk/room.rb', line 560 def unban_user(user_id) user_id = user_id.id if user_id.is_a? MatrixSdk::User client.api.unban_user(id, user_id) true end |
#user_can_send?(user, event, state: false) ⇒ Boolean
Checks if a user can send a given event type in the room
832 833 834 835 836 837 838 |
# File 'lib/matrix_sdk/room.rb', line 832 def user_can_send?(user, event, state: false) user_pl = user_powerlevel(user) event_pl = power_levels.dig(:events, event.to_s.to_sym) event_pl ||= state ? (power_levels[:state_default] || 50) : (power_levels[:events_default] || 0) user_pl >= event_pl end |
#user_powerlevel(user, use_default: true) ⇒ Integer?
Gets the power level of a user in the room
816 817 818 819 820 821 822 823 824 |
# File 'lib/matrix_sdk/room.rb', line 816 def user_powerlevel(user, use_default: true) user = user.id if user.is_a? User user = MXID.new(user.to_s) unless user.is_a? MXID raise ArgumentError, 'Must provide a valid User or MXID' unless user.user? level = power_levels.dig(:users, user.to_s.to_sym) level ||= power_levels[:users_default] || 0 if use_default level end |
#world_readable? ⇒ Boolean Also known as: world_readable
Checks if the room history is world readable
321 322 323 |
# File 'lib/matrix_sdk/room.rb', line 321 def world_readable? history_visibility == :world_readable end |