Class: MatrixSdk::User

Inherits:
Object show all
Extended by:
Extensions
Defined in:
lib/matrix_sdk/user.rb

Overview

A class for tracking information about a user on Matrix

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Extensions

events, ignore_inspect

Constructor Details

#initialize(client, id, data = {}) ⇒ User

Returns a new instance of User.



19
20
21
22
23
24
25
26
27
28
29
# File 'lib/matrix_sdk/user.rb', line 19

def initialize(client, id, data = {})
  @client = client
  @id = id

  @display_name = nil
  @avatar_url = nil

  data.each do |k, v|
    instance_variable_set("@#{k}", v) if instance_variable_defined? "@#{k}"
  end
end

Instance Attribute Details

#clientObject (readonly)

Returns the value of attribute client.



10
11
12
# File 'lib/matrix_sdk/user.rb', line 10

def client
  @client
end

#idObject (readonly) Also known as: user_id

Returns the value of attribute id.



10
11
12
# File 'lib/matrix_sdk/user.rb', line 10

def id
  @id
end

Instance Method Details

#active?Boolean

Note:

This information is not cached in the abstraction layer

Returns if the user is currently active.

Returns:

  • (Boolean)

    if the user is currently active



93
94
95
# File 'lib/matrix_sdk/user.rb', line 93

def active?
  raw_presence[:currently_active] == true
end

#avatar_urlObject

Gets the avatar for the user



53
54
55
# File 'lib/matrix_sdk/user.rb', line 53

def avatar_url
  @avatar_url ||= client.api.get_avatar_url(id)[:avatar_url]
end

#avatar_url=(url) ⇒ Object

Note:

Requires a mxc:// URL, check example on Protocols::CS#set_avatar_url for how this can be done

Set a new avatar for the user

Only works for the current user object, as requested by

client.get_user(:self)

Parameters:

  • url (String, URI::MXC)

    the new avatar URL

See Also:



66
67
68
69
# File 'lib/matrix_sdk/user.rb', line 66

def avatar_url=(url)
  client.api.set_avatar_url(id, url)
  @avatar_url = url
end

#device_keysObject

Returns all the current device keys for the user, retrieving them if necessary



134
135
136
137
138
# File 'lib/matrix_sdk/user.rb', line 134

def device_keys
  @device_keys ||= client.api.keys_query(device_keys: { id => [] }).yield_self do |resp|
    resp[:device_keys][id.to_sym]
  end
end

#direct_roomRoom?

Gets a direct message room with the user if one exists

Returns:

  • (Room, nil)

    A direct message room if one exists

See Also:



129
130
131
# File 'lib/matrix_sdk/user.rb', line 129

def direct_room
  client.direct_room(id)
end

#display_nameString

Returns the display name.

Returns:

  • (String)

    the display name

See Also:



33
34
35
# File 'lib/matrix_sdk/user.rb', line 33

def display_name
  @display_name ||= client.api.get_display_name(id)[:displayname]
end

#display_name=(name) ⇒ Object

Parameters:

  • name (String)

    the display name to set

See Also:



39
40
41
42
# File 'lib/matrix_sdk/user.rb', line 39

def display_name=(name)
  client.api.set_display_name(id, name)
  @display_name = name
end

#friendly_nameString

Gets a friendly name of the user

Returns:

  • (String)

    either the display name or MXID if unset



46
47
48
# File 'lib/matrix_sdk/user.rb', line 46

def friendly_name
  display_name || id
end

#inspectString

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



17
# File 'lib/matrix_sdk/user.rb', line 17

ignore_inspect :client

#last_activeTime

Note:

This information is not cached in the abstraction layer

Gets the last time the user was active at, from the server's side

Returns:

  • (Time)

    when the user was last active

See Also:



118
119
120
121
122
123
# File 'lib/matrix_sdk/user.rb', line 118

def last_active
  since = raw_presence[:last_active_ago]
  return unless since

  Time.now - (since / 1000)
end

#presenceSymbol

Note:

This information is not cached in the abstraction layer

Get the user's current presence status

Returns:

  • (Symbol)

    One of :online, :offline, :unavailable

See Also:



76
77
78
# File 'lib/matrix_sdk/user.rb', line 76

def presence
  raw_presence[:presence].to_sym
end

#presence=(new_presence) ⇒ Object

Sets the user's current presence status Should be one of :online, :offline, or :unavailable

Parameters:

  • new_presence (:online, :offline, :unavailable)

    The new presence status to set

Raises:

  • (ArgumentError)

See Also:



85
86
87
88
89
# File 'lib/matrix_sdk/user.rb', line 85

def presence=(new_presence)
  raise ArgumentError, 'Presence must be one of :online, :offline, :unavailable' unless %i[online offline unavailable].include?(presence)

  client.api.set_presence_status(id, new_presence)
end

#status_msgObject

Note:

This information is not cached in the abstraction layer

Gets the user-specified status message - if any



101
102
103
# File 'lib/matrix_sdk/user.rb', line 101

def status_msg
  raw_presence[:status_msg]
end

#status_msg=(message) ⇒ Object

Sets the user-specified status message

Parameters:

  • message (String, nil)

    The message to set, or nil for no message

See Also:



109
110
111
# File 'lib/matrix_sdk/user.rb', line 109

def status_msg=(message)
  client.api.set_presence_status(id, presence, message: message)
end