Class: MatrixSdk::Room

Inherits:
Object show all
Extended by:
Extensions, Util::Tinycache
Includes:
Logging
Defined in:
lib/matrix_sdk/room.rb

Overview

A class for tracking the information about a room on Matrix

Direct Known Subclasses

MatrixSdk::Rooms::Space

Constant Summary

Constants included from Util::Tinycache

Util::Tinycache::CACHE_LEVELS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Extensions

ignore_inspect

Methods included from Util::Tinycache

adapter, adapter=, cached, extended, tinycache_adapter_config

Methods included from Logging

#logger, #logger=

Constructor Details

#initialize(client, room_id, data = {}) ⇒ Room

Note:

This method isn’t supposed to be used directly, rather rooms should be retrieved from the Client abstraction.

Create a new room instance

Parameters:

  • client (Client) —

    The underlying connection

  • room_id (MXID) —

    The room ID

  • data (Hash) (defaults to: {}) —

    Additional data to assign to the room

Options Hash (data):

  • :name (String) —

    The current name of the room

  • :topic (String) —

    The current topic of the room

  • :canonical_alias (String, MXID) —

    The canonical alias of the room

  • :aliases (Array(String, MXID)) —

    All non-canonical aliases of the room

  • :join_rule (:invite, :public, :knock) —

    The join rule for the room

  • :guest_access (:can_join, :forbidden) —

    The guest access setting for the room

  • :world_readable (Boolean) —

    If the room is readable by the entire world

  • :members (Array(User)) —

    The list of joined members

  • :events (Array(Object)) —

    The list of current events in the room

  • :members_loaded (Boolean) —

    If the list of members is already loaded

  • :event_history_limit (Integer) — default: 10 —

    The limit of events to store for the room

  • :avatar_url (String, URI) —

    The avatar URL for the room

  • :prev_batch (String) —

    The previous batch token for backfill

Raises:

  • (ArgumentError) 


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
 
# File 'lib/matrix_sdk/room.rb', line 67

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

  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.

Returns:

  • (Client) —

    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.

Returns:

  • (Fixnum) —

    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.

Returns:

  • (String) —

    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) 



132
133
134
 
# File 'lib/matrix_sdk/room.rb', line 132

def 
  ensure_room_handlers[:account_data]
end

#on_ephemeral_event ⇒ Object (readonly) 



144
145
146
 
# File 'lib/matrix_sdk/room.rb', line 144

def on_ephemeral_event
  ensure_room_handlers[:ephemeral_event]
end

#on_event ⇒ Object (readonly) 



126
127
128
 
# File 'lib/matrix_sdk/room.rb', line 126

def on_event
  ensure_room_handlers[:event]
end

#on_state_event ⇒ Object (readonly) 



138
139
140
 
# File 'lib/matrix_sdk/room.rb', line 138

def on_state_event
  ensure_room_handlers[:state_event]
end

Instance Method Details

#account_data ⇒ Object 



556
557
558
559
560
 
# File 'lib/matrix_sdk/room.rb', line 556

def 
  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

Returns:

  • (Boolean) —

    if the addition was successful or not



727
728
729
730
731
 
# File 'lib/matrix_sdk/room.rb', line 727

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

Parameters:

  • tag (String) —

    The tag to add

  • data (Hash) —

    The data to assign to the tag



672
673
674
675
 
# File 'lib/matrix_sdk/room.rb', line 672

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

Parameters:

  • user (User, MXID, String) —

    The user to give admin privileges

  • level (Integer) (defaults to: 100) —

    The power level to set the user to

Raises:

  • (ArgumentError)

See Also:



846
847
848
849
850
851
852
853
854
 
# File 'lib/matrix_sdk/room.rb', line 846

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

Parameters:

  • user (User, MXID, String) —

    The user to check for admin privileges

  • target_level (Integer) (defaults to: 100) —

    The power level that’s to be considered as admin privileges

Returns:

  • (Boolean) —

    If the requested user has a power level highe enough to be an admin

See Also:



834
835
836
837
838
839
 
# File 'lib/matrix_sdk/room.rb', line 834

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

Parameters:

  • canonical_only (Boolean) (defaults to: true) —

    Should the list of aliases only contain the canonical ones

Returns:

  • (Array[String]) —

    The assigned room aliases



311
312
313
314
315
316
317
 
# File 'lib/matrix_sdk/room.rb', line 311

def aliases(canonical_only: true)
  canonical = client.api.get_room_state(id, '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)

Note:

This will also count members who’ve knocked, been invited, have left, or have been banned.

Get all members (member events) in the room

Parameters:

  • params (Hash) —

    Additional query parameters to pass to the room member listing - e.g. for filtering purposes.

Returns:

  • (Array(User)) —

    The complete list of members in the room, regardless of membership state



201
202
203
 
# File 'lib/matrix_sdk/room.rb', line 201

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

Parameters:

  • allow_guests (Boolean) —

    If guests are allowed to join or not



763
764
765
766
 
# File 'lib/matrix_sdk/room.rb', line 763

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

Returns:

  • (String, nil) —

    The avatar URL - if any



246
247
248
249
250
251
 
# File 'lib/matrix_sdk/room.rb', line 246

def avatar_url
  client.api.get_room_avatar(id)[:url]
rescue MatrixNotFoundError
  # No avatar has been set
  nil
end

#avatar_url=(avatar_url) ⇒ Object

Sets a new avatar URL for the room

Parameters:

  • avatar_url (URI::MXC) —

    The mxc:// URL for the new room avatar

Raises:

  • (ArgumentError) 


780
781
782
783
784
785
786
787
 
# File 'lib/matrix_sdk/room.rb', line 780

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

  client.api.set_room_avatar(id, avatar_url)
  tinycache_adapter.write(:avatar_url, avatar_url)
  avatar_url
end

#backfill_messages(*args, reverse: false, limit: 10) ⇒ Object

Note:

This will trigger the on_event events as messages are added

Backfills messages into the room history

Parameters:

  • reverse (Boolean) (defaults to: false) —

    whether to fill messages in reverse or not

  • limit (Integer) (defaults to: 10) —

    the maximum number of messages to backfill



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/matrix_sdk/room.rb', line 484

def backfill_messages(*args, reverse: false, limit: 10)
  # To be backwards-compatible
  if args.length == 2
    reverse = args.first
    limit = args.last
  end

  data = client.api.get_room_messages(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

Parameters:

  • user_id (String, User) —

    the MXID of the user

  • reason (String) (defaults to: '') —

    the reason for the ban

Returns:

  • (Boolean) —

    wether the action succeeded



531
532
533
534
535
 
# File 'lib/matrix_sdk/room.rb', line 531

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.

Returns:

  • (String, nil) —

    the canonical alias of the room



177
178
179
180
181
 
# File 'lib/matrix_sdk/room.rb', line 177

def canonical_alias
  client.api.get_room_state(id, 'm.room.canonical_alias')[:alias]
rescue MatrixSdk::MatrixNotFoundError
  nil
end

#creation_info ⇒ Response

Gets the room creation information

Returns:

  • (Response) —

    The content of the m.room.create event



600
601
602
603
 
# File 'lib/matrix_sdk/room.rb', line 600

def creation_info
  # Not caching here, easier to cache the important values separately instead
  client.api.get_room_creation_info(id)
end

#display_name ⇒ String

Note:

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.

Returns:

  • (String) —

    a human-readable name for the room



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/matrix_sdk/room.rb', line 161

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/matrix_sdk/room.rb', line 228

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.['m.direct'] = rooms if dirty
end

#dm?(members_only: false) ⇒ Boolean

Checks if the room is a direct message / 1:1 room

Parameters:

  • members_only (Boolean) (defaults to: false) —

    Should directness only care about member count?

Returns:

  • (Boolean) 


221
222
223
224
225
 
# File 'lib/matrix_sdk/room.rb', line 221

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

Parameters:

  • type (String) —

    the data type to retrieve

Returns:

  • (Hash) —

    the data that was stored under the given type



566
567
568
 
# File 'lib/matrix_sdk/room.rb', line 566

def (type)
  [type]
end

#guest_access ⇒ :can_join, :forbidden

Gets the guest access rights for the room

Returns:

  • (:can_join, :forbidden) —

    The current guest access right



266
267
268
 
# File 'lib/matrix_sdk/room.rb', line 266

def guest_access
  client.api.get_room_guest_access(id)[:guest_access]&.to_sym
end

#guest_access=(guest_access) ⇒ Object

Sets the guest access status for the room

Parameters:

  • guest_access (:can_join, :forbidden) —

    The new guest access status of the room



771
772
773
774
775
 
# File 'lib/matrix_sdk/room.rb', line 771

def guest_access=(guest_access)
  client.api.set_room_guest_access(id, guest_access)
  tinycache_adapter.write(:guest_access, guest_access)
  guest_access
end

#guest_access? ⇒ Boolean

Checks if guest_access is set to :can_join

Returns:

  • (Boolean) 


278
279
280
 
# File 'lib/matrix_sdk/room.rb', line 278

def guest_access?
  guest_access == :can_join
end

#history_visibility ⇒ :invited, ...

Gets the history visibility of the room

Returns:

  • (:invited, :joined, :shared, :world_readable) —

    The current history visibility for the room



295
296
297
 
# File 'lib/matrix_sdk/room.rb', line 295

def history_visibility
  client.api.get_room_state(id, '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.

Returns:

  • (String) —

    a regular inspect string without the data for some variables



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

Parameters:

  • invite_only (Boolean) —

    If it should be invite only or not



746
747
748
749
 
# File 'lib/matrix_sdk/room.rb', line 746

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

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/matrix_sdk/room.rb', line 283

def invite_only?
  join_rule == :invite
end

#invite_user(user_id) ⇒ Boolean

Invites a user into the room

Parameters:

  • user_id (String, User) —

    the MXID of the user

Returns:

  • (Boolean) —

    wether the action succeeded



509
510
511
512
513
 
# File 'lib/matrix_sdk/room.rb', line 509

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

Returns:

  • (:public, :knock, :invite, :private) —

    The current join rule



273
274
275
 
# File 'lib/matrix_sdk/room.rb', line 273

def join_rule
  client.api.get_room_join_rules(id)[:join_rule]&.to_sym
end

#join_rule=(join_rule) ⇒ Object

Sets the join rule of the room

Parameters:

  • join_rule (:invite, :public) —

    The join rule of the room



754
755
756
757
758
 
# File 'lib/matrix_sdk/room.rb', line 754

def join_rule=(join_rule)
  client.api.set_room_join_rules(id, join_rule)
  tinycache_adapter.write(:join_rule, join_rule)
  join_rule
end

#joined_members ⇒ Array(User)

Populates and returns the #members array

Returns:

  • (Array(User)) —

    The list of members in the room



186
187
188
189
190
191
192
 
# File 'lib/matrix_sdk/room.rb', line 186

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

Parameters:

  • user_id (String, User) —

    the MXID of the user

  • reason (String) (defaults to: '') —

    the reason for the kick

Returns:

  • (Boolean) —

    wether the action succeeded



520
521
522
523
524
 
# File 'lib/matrix_sdk/room.rb', line 520

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

Returns:

  • (Boolean) 


288
289
290
 
# File 'lib/matrix_sdk/room.rb', line 288

def knock_only?
  join_rule == :knock
end

#leave ⇒ Boolean

Requests to be removed from the room

Returns:

  • (Boolean) —

    wether the request succeeded



550
551
552
553
554
 
# File 'lib/matrix_sdk/room.rb', line 550

def leave
  client.api.leave_room(id)
  client.instance_variable_get(:@rooms).delete id
  true
end

#members ⇒ Object 



44
 
# File 'lib/matrix_sdk/room.rb', line 44

alias members joined_members

#moderator!(user, level: 50) ⇒ Object

Make a user a moderator in the room

Parameters:

  • user (User, MXID, String) —

    The user to give moderator privileges

  • level (Integer) (defaults to: 50) —

    The power level to set the user to

Raises:

  • (ArgumentError)

See Also:



874
875
876
877
878
879
880
881
882
 
# File 'lib/matrix_sdk/room.rb', line 874

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

Parameters:

  • user (User, MXID, String) —

    The user to check for admin privileges

  • target_level (Integer) (defaults to: 50) —

    The power level that’s to be considered as admin privileges

Returns:

  • (Boolean) —

    If the requested user has a power level highe enough to be an admin

See Also:



862
863
864
865
866
867
 
# File 'lib/matrix_sdk/room.rb', line 862

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

Parameters:

  • events (Hash) (defaults to: nil) —

    the event-specific power levels to change

  • params (Hash) (defaults to: {}) —

    other power-level params to change

Returns:

  • (Boolean) —

    if the change was successful



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/matrix_sdk/room.rb', line 920

def modify_required_power_levels(events = nil, params = {})
  return false if events.nil? && (params.nil? || params.empty?)

  data = power_levels_without_cache
  tinycache_adapter.write(:power_levels, data)
  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

  client.api.set_power_levels(id, data)
  true
end

#modify_user_power_levels(users = nil, users_default = nil) ⇒ Boolean

Modifies the power levels of the room

Parameters:

  • users (Hash) (defaults to: nil) —

    the user-specific power levels to set or remove

  • users_default (Hash) (defaults to: nil) —

    the default user power levels to set

Returns:

  • (Boolean) —

    if the change was successful



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/matrix_sdk/room.rb', line 889

def modify_user_power_levels(users = nil, users_default = nil)
  return false if users.nil? && users_default.nil?

  data = power_levels_without_cache
  tinycache_adapter.write(:power_levels, data)
  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

  client.api.set_power_levels(id, data)
  true
end

#name ⇒ String?

Note:

Will cache the current name for 15 minutes

Gets the current name of the room, querying the API if necessary

Returns:

  • (String, nil) —

    The room name - if any



210
211
212
213
214
215
 
# File 'lib/matrix_sdk/room.rb', line 210

def name
  client.api.get_room_name(id)[:name]
rescue MatrixNotFoundError
  # No room name has been specified
  nil
end

#name=(name) ⇒ Object

Sets a new name on the room

Parameters:

  • name (String) —

    The new name to set



693
694
695
696
697
 
# File 'lib/matrix_sdk/room.rb', line 693

def name=(name)
  tinycache_adapter.write(:name, name)
  client.api.set_room_name(id, name)
  name
end

#power_levels ⇒ Hash

Note:

The returned power levels are cached for a minute

Get the power levels of the room

Returns:

  • (Hash) —

    The current power levels as set for the room

See Also:



794
795
796
 
# File 'lib/matrix_sdk/room.rb', line 794

def power_levels
  client.api.get_power_levels(id)
end

#redact_message(event_id, reason = nil) ⇒ Object

Redacts a message from the room

Parameters:

  • event_id (String) —

    the ID of the event to redact

  • reason (String, nil) (defaults to: nil) —

    the reason for the redaction



464
465
466
467
 
# File 'lib/matrix_sdk/room.rb', line 464

def redact_message(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



682
683
684
685
686
687
 
# File 'lib/matrix_sdk/room.rb', line 682

def reload!
  reload_name!
  reload_topic!
  reload_aliases!
  true
end

#reload_aliases! ⇒ Boolean Also known as: refresh_aliases!

Note:

The list of aliases is not sorted, ordering changes will result in alias list updates.

Reloads the list of aliases by an API query

Returns:

  • (Boolean) —

    if the alias list was updated or not



738
739
740
 
# File 'lib/matrix_sdk/room.rb', line 738

def reload_aliases!
  clear_aliases_cache
end

#reload_name! ⇒ Boolean Also known as: refresh_name!

Reloads the name of the room

Returns:

  • (Boolean) —

    if the name was changed or not



702
703
704
 
# File 'lib/matrix_sdk/room.rb', line 702

def reload_name!
  clear_name_cache
end

#reload_topic! ⇒ Boolean Also known as: refresh_topic!

Reloads the topic of the room

Returns:

  • (Boolean) —

    if the topic was changed or not



719
720
721
 
# File 'lib/matrix_sdk/room.rb', line 719

def reload_topic!
  clear_topic_cache
end

#remove_tag(tag) ⇒ Object

Remove a tag from the room

Parameters:

  • tag (String) —

    The tag to remove



663
664
665
666
 
# File 'lib/matrix_sdk/room.rb', line 663

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

Parameters:

  • event_id (MXID, String) —

    The ID of the event to redact

  • reason (String) —

    The reason for the report

  • score (Integer) (defaults to: -100)) —

    The severity of the report in the range of -100 - 0



474
475
476
477
 
# File 'lib/matrix_sdk/room.rb', line 474

def report_message(event_id, reason:, score: -100)
  client.api.report_event(id, event_id, reason: reason, score: score)
  true
end

#room_type ⇒ 'm.space', ...

Retrieves the type of the room

Returns:

  • ('m.space', String, nil) —

    The type of the room



608
609
610
611
612
613
614
 
# File 'lib/matrix_sdk/room.rb', line 608

def room_type
  # Can't change, so a permanent cache is ok
  return @room_type if @room_type_retrieved || @room_type

  @room_type_retrieved = true
  @room_type ||= creation_info[:type]
end

#room_version ⇒ String

Retrieves the room version

Returns:

  • (String) —

    The version of the room



619
620
621
 
# File 'lib/matrix_sdk/room.rb', line 619

def room_version
  @room_version ||= creation_info[:room_version]
end

#send_audio(url, name, audio_info = {}) ⇒ Object

Note:

The URLs should all be of the ‘mxc://’ schema

Sends a link to an audio clip to the room

Parameters:

  • url (String, URI) —

    the URL to the audio clip

  • name (String) —

    the name of the audio clip

  • audio_info (Hash) (defaults to: {}) —

    extra information about the audio clip

Options Hash (audio_info):

  • :duration (Integer) —

    the duration of the audio clip in milliseconds

  • :mimetype (String) —

    the MIME type of the audio clip

  • :size (Integer) —

    the size of the audio clip in bytes



431
432
433
 
# File 'lib/matrix_sdk/room.rb', line 431

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

Parameters:

  • body (String) —

    The clear-text body of the message

  • content (Hash) (defaults to: {}) —

    The custom content of the message

  • msgtype (String) (defaults to: nil) —

    The type of the message, should be one of the known types (m.text, m.notice, m.emote, etc)



440
441
442
443
444
445
446
447
 
# File 'lib/matrix_sdk/room.rb', line 440

def send_custom_message(body, content = {}, msgtype: nil)
  content.merge!(
    body: body,
    msgtype: msgtype || 'm.text'
  )

  client.api.send_message_event(id, 'm.room.message', content)
end

#send_emote(text) ⇒ Object

Sends an emote (/me) message to the room

Parameters:

  • text (String) —

    the emote to send



353
354
355
 
# File 'lib/matrix_sdk/room.rb', line 353

def send_emote(text)
  client.api.send_emote(id, text)
end

#send_event(type, content = {}) ⇒ Object

Sends a custom timeline event to the Room

Parameters:

  • type (String, Symbol) —

    The type of the Event. For custom events, this should be written in reverse DNS format (e.g. com.example.event)

  • content (Hash) (defaults to: {}) —

    The contents of the message, this will be the :content key of the resulting event object

See Also:



456
457
458
 
# File 'lib/matrix_sdk/room.rb', line 456

def send_event(type, content = {})
  client.api.send_message_event(id, type, content)
end

#send_file(url, name, file_info = {}) ⇒ Object

Note:

The URLs should all be of the ‘mxc://’ schema

Sends a link to a generic file to the room

Parameters:

  • url (String, URI) —

    the URL to the file

  • name (String) —

    the name of the file

  • file_info (Hash) (defaults to: {}) —

    extra information about the file

Options Hash (file_info):

  • :mimetype (String) —

    the MIME type of the file

  • :size (Integer) —

    the size of the file in bytes

  • :thumbnail_url (String, URI) —

    the URL to a thumbnail of the file

  • :thumbnail_info (Hash) —

    ThumbnailInfo about the thumbnail file



367
368
369
 
# File 'lib/matrix_sdk/room.rb', line 367

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

Parameters:

  • html (String) —

    the HTML message to send

  • body (String, nil) (defaults to: nil) —

    a plain-text representation of the object (Will default to the HTML with all tags stripped away)

  • msgtype (String) (defaults to: nil) —

    (‘m.text’) The message type for the message

  • format (String) (defaults to: nil) —

    (‘org.matrix.custom.html’) The message format

See Also:



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/matrix_sdk/room.rb', line 339

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.send_message_event(id, 'm.room.message', content)
end

#send_image(url, name, image_info = {}) ⇒ Object

Note:

The URLs should all be of the ‘mxc://’ schema

Sends a link to an image to the room

Parameters:

  • url (String, URI) —

    the URL to the image

  • name (String) —

    the name of the image

  • image_info (Hash) (defaults to: {}) —

    extra information about the image

Options Hash (image_info):

  • :h (Integer) —

    the height of the image in pixels

  • :w (Integer) —

    the width of the image in pixels

  • :mimetype (String) —

    the MIME type of the image

  • :size (Integer) —

    the size of the image in bytes

  • :thumbnail_url (String, URI) —

    the URL to a thumbnail of the image

  • :thumbnail_info (Hash) —

    ThumbnailInfo about the thumbnail image



390
391
392
 
# File 'lib/matrix_sdk/room.rb', line 390

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

Note:

The thumbnail URL should be of the ‘mxc://’ schema

Sends a location object to the room

Parameters:

  • geo_uri (String, URI) —

    the geo-URL (e.g. geo:<coords>) of the location

  • name (String) —

    the name of the location

  • thumbnail_url (String, URI) (defaults to: nil) —

    the URL to a thumbnail image of the location

  • thumbnail_info (Hash) (defaults to: {}) —

    a ThumbnailInfo for the location thumbnail



401
402
403
 
# File 'lib/matrix_sdk/room.rb', line 401

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

Parameters:

  • text (String) —

    the notice to send



374
375
376
 
# File 'lib/matrix_sdk/room.rb', line 374

def send_notice(text)
  client.api.send_notice(id, text)
end

#send_text(text) ⇒ Object

Sends a plain-text message to the room

Parameters:

  • text (String) —

    the message to send



326
327
328
 
# File 'lib/matrix_sdk/room.rb', line 326

def send_text(text)
  client.api.send_message(id, text)
end

#send_video(url, name, video_info = {}) ⇒ Object

Note:

The URLs should all be of the ‘mxc://’ schema

Sends a link to a video to the room

Parameters:

  • url (String, URI) —

    the URL to the video

  • name (String) —

    the name of the video

  • video_info (Hash) (defaults to: {}) —

    extra information about the video

Options Hash (video_info):

  • :duration (Integer) —

    the duration of the video in milliseconds

  • :h (Integer) —

    the height of the video in pixels

  • :w (Integer) —

    the width of the video in pixels

  • :mimetype (String) —

    the MIME type of the video

  • :size (Integer) —

    the size of the video in bytes

  • :thumbnail_url (String, URI) —

    the URL to a thumbnail of the video

  • :thumbnail_info (Hash) —

    ThumbnailInfo about the thumbnail of the video



418
419
420
 
# File 'lib/matrix_sdk/room.rb', line 418

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

Parameters:

  • type (String) —

    the data type to store

  • account_data (Hash) —

    the data to store



574
575
576
577
 
# File 'lib/matrix_sdk/room.rb', line 574

def (type, )
  self.[type] = 
  true
end

#set_user_profile(display_name: nil, avatar_url: nil, reason: nil) ⇒ Object

Note:

the avatar URL should be a mxc:// URI

Changes the room-specific user profile

Parameters:

  • display_name (String) (defaults to: nil) —

    the new display name to use in the room

  • avatar_url (String, URI) (defaults to: nil) —

    the new avatar URL to use in the room



584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/matrix_sdk/room.rb', line 584

def (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

Returns:

  • (Boolean, nil) —

    True if the room is a space



626
627
628
629
630
 
# File 'lib/matrix_sdk/room.rb', line 626

def space?
  room_type == 'm.space'
rescue MatrixSdk::MatrixForbiddenError, MatrixSdk::MatrixNotFoundError
  nil
end

#tags ⇒ Response

Returns a list of the room tags

Examples:

Managing tags

room.tags
# => { :room_tag => { data: false } }
room.tags.add('some_tag', data: true)
# => { :some_tag => { data: true }, :room_tag => { data: false} }
room.tags.remove('room_tag')
# => { :some_tag => { data: true} }

Returns:

  • (Response) —

    A list of the tags and their data, with add and remove methods implemented



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/matrix_sdk/room.rb', line 642

def tags
  client.api.get_user_tags(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 



112
113
114
115
116
117
118
 
# File 'lib/matrix_sdk/room.rb', line 112

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



106
107
108
109
110
 
# File 'lib/matrix_sdk/room.rb', line 106

def to_space
  return nil unless space?

  Rooms::Space.new self, nil
end

#topic ⇒ String?

Gets the room topic - if any

Returns:

  • (String, nil) —

    The topic of the room



256
257
258
259
260
261
 
# File 'lib/matrix_sdk/room.rb', line 256

def topic
  client.api.get_room_topic(id)[:topic]
rescue MatrixNotFoundError
  # No room name has been specified
  nil
end

#topic=(topic) ⇒ Object

Sets a new topic on the room

Parameters:

  • topic (String) —

    The new topic to set



710
711
712
713
714
 
# File 'lib/matrix_sdk/room.rb', line 710

def topic=(topic)
  tinycache_adapter.write(:topic, topic)
  client.api.set_room_topic(id, topic)
  topic
end

#unban_user(user_id) ⇒ Boolean

Unbans a user from the room

Parameters:

  • user_id (String, User) —

    the MXID of the user

Returns:

  • (Boolean) —

    wether the action succeeded



541
542
543
544
545
 
# File 'lib/matrix_sdk/room.rb', line 541

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

Parameters:

  • user (User, MXID, String) —

    The user to check

  • event (String, Symbol) —

    The event type to check

  • state (Boolean) (defaults to: false) —

    If the given event is a state event or a message event

Returns:

  • (Boolean) —

    If the given user is allowed to send an event of the given type



820
821
822
823
824
825
826
 
# File 'lib/matrix_sdk/room.rb', line 820

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

Parameters:

  • user (User, MXID, String) —

    The user to check the power level for

  • use_default (Boolean) (defaults to: true) —

    Should the user default level be checked if no user-specific one exists

Returns:

  • (Integer, nil) —

    The current power level for the requested user, nil if there’s no user specific level and use_default is false

Raises:

  • (ArgumentError) 


804
805
806
807
808
809
810
811
812
 
# File 'lib/matrix_sdk/room.rb', line 804

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

Returns:

  • (Boolean) —

    If the history is world readable



302
303
304
 
# File 'lib/matrix_sdk/room.rb', line 302

def world_readable?
  history_visibility == :world_readable
end