Class: Murmur::API::User
- Inherits:
-
Object
- Object
- Murmur::API::User
- Defined in:
- lib/murmur/user.rb
Instance Method Summary collapse
- #bytes_per_sec ⇒ Object
- #channel ⇒ Object
- #channel=(channel) ⇒ Object
- #clientdeafened=(clientdeafened) ⇒ Object
- #clientdeafened? ⇒ Boolean
- #clientmuted=(clientmuted) ⇒ Object
- #clientmuted? ⇒ Boolean
- #comment ⇒ Object
- #comment=(comment) ⇒ Object
- #context ⇒ Object
- #deafened=(deafened) ⇒ Object
- #deafened? ⇒ Boolean
- #identity ⇒ Object
-
#initialize(host, meta, server, user) ⇒ User
constructor
A new instance of User.
- #kick!(reason = "Kicked by server") ⇒ Object
- #muted=(muted) ⇒ Object
- #muted? ⇒ Boolean
- #name ⇒ Object
- #name=(name) ⇒ Object
- #os ⇒ Object
- #os_version ⇒ Object
- #ping ⇒ Object
- #priorityspeaker=(priorityspeaker) ⇒ Object
- #priorityspeaker? ⇒ Boolean
- #raw ⇒ Object
- #recording=(recording) ⇒ Object
- #recording? ⇒ Boolean
- #registered? ⇒ Boolean
- #release ⇒ Object
- #seconds_connected ⇒ Object
- #seconds_idle ⇒ Object
- #server ⇒ Object
- #session ⇒ Object (also: #id)
- #suppressed=(suppressed) ⇒ Object
- #suppressed? ⇒ Boolean
- #tcponly=(tcponly) ⇒ Object
- #tcponly? ⇒ Boolean
- #tcpPing ⇒ Object
- #udpPing ⇒ Object
- #userid ⇒ Object
- #version ⇒ Object
Constructor Details
#initialize(host, meta, server, user) ⇒ User
Returns a new instance of User.
5 6 7 8 9 10 |
# File 'lib/murmur/user.rb', line 5 def initialize(host, , server, user) @host = host = @server = server @user = user end |
Instance Method Details
#bytes_per_sec ⇒ Object
118 119 120 |
# File 'lib/murmur/user.rb', line 118 def bytes_per_sec @user.bytespersec end |
#channel ⇒ Object
88 89 90 |
# File 'lib/murmur/user.rb', line 88 def channel @server.channel @user.channel end |
#channel=(channel) ⇒ Object
92 93 94 95 |
# File 'lib/murmur/user.rb', line 92 def channel=(channel) @user.channel = channel update end |
#clientdeafened=(clientdeafened) ⇒ Object
74 75 76 77 |
# File 'lib/murmur/user.rb', line 74 def clientdeafened=(clientdeafened) @user.selfDeaf = clientdeafened update end |
#clientdeafened? ⇒ Boolean
70 71 72 |
# File 'lib/murmur/user.rb', line 70 def clientdeafened? @user.selfDeaf end |
#clientmuted=(clientmuted) ⇒ Object
65 66 67 68 |
# File 'lib/murmur/user.rb', line 65 def clientmuted=(clientmuted) @user.selfMute = clientmuted update end |
#clientmuted? ⇒ Boolean
61 62 63 |
# File 'lib/murmur/user.rb', line 61 def clientmuted? @user.selfMute end |
#comment ⇒ Object
146 147 148 |
# File 'lib/murmur/user.rb', line 146 def comment @user.comment end |
#comment=(comment) ⇒ Object
150 151 152 153 |
# File 'lib/murmur/user.rb', line 150 def comment=(comment) @user.comment = comment update end |
#context ⇒ Object
142 143 144 |
# File 'lib/murmur/user.rb', line 142 def context @user.context end |
#deafened=(deafened) ⇒ Object
38 39 40 41 |
# File 'lib/murmur/user.rb', line 38 def deafened=(deafened) @user.deaf = deafened update end |
#deafened? ⇒ Boolean
34 35 36 |
# File 'lib/murmur/user.rb', line 34 def deafened? @user.deaf end |
#identity ⇒ Object
138 139 140 |
# File 'lib/murmur/user.rb', line 138 def identity @user.identity end |
#kick!(reason = "Kicked by server") ⇒ Object
176 177 178 |
# File 'lib/murmur/user.rb', line 176 def kick!(reason="Kicked by server") @server.kickUser(@user.session, reason) end |
#muted=(muted) ⇒ Object
29 30 31 32 |
# File 'lib/murmur/user.rb', line 29 def muted=(muted) @user.mute = muted update end |
#muted? ⇒ Boolean
25 26 27 |
# File 'lib/murmur/user.rb', line 25 def muted? @user.mute end |
#name ⇒ Object
101 102 103 |
# File 'lib/murmur/user.rb', line 101 def name @user.name end |
#name=(name) ⇒ Object
105 106 107 108 |
# File 'lib/murmur/user.rb', line 105 def name=(name) @user.name = name update end |
#os ⇒ Object
130 131 132 |
# File 'lib/murmur/user.rb', line 130 def os @user.os end |
#os_version ⇒ Object
134 135 136 |
# File 'lib/murmur/user.rb', line 134 def os_version @user.osversion end |
#ping ⇒ Object
164 165 166 |
# File 'lib/murmur/user.rb', line 164 def ping {:udp => @user.udpPing, :tcp => @user.tcpPing} end |
#priorityspeaker=(priorityspeaker) ⇒ Object
56 57 58 59 |
# File 'lib/murmur/user.rb', line 56 def priorityspeaker=(priorityspeaker) @user.prioritySpeaker = priorityspeaker update end |
#priorityspeaker? ⇒ Boolean
52 53 54 |
# File 'lib/murmur/user.rb', line 52 def priorityspeaker? @user.prioritySpeaker end |
#raw ⇒ Object
180 181 182 |
# File 'lib/murmur/user.rb', line 180 def raw @user end |
#recording=(recording) ⇒ Object
83 84 85 86 |
# File 'lib/murmur/user.rb', line 83 def recording=(recording) @user.recording update end |
#recording? ⇒ Boolean
79 80 81 |
# File 'lib/murmur/user.rb', line 79 def recording? @user.recording end |
#registered? ⇒ Boolean
21 22 23 |
# File 'lib/murmur/user.rb', line 21 def registered? @user.userid != -1 end |
#release ⇒ Object
126 127 128 |
# File 'lib/murmur/user.rb', line 126 def release @user.release end |
#seconds_connected ⇒ Object
110 111 112 |
# File 'lib/murmur/user.rb', line 110 def seconds_connected @user.onlinesecs end |
#seconds_idle ⇒ Object
114 115 116 |
# File 'lib/murmur/user.rb', line 114 def seconds_idle @user.idlesecs end |
#server ⇒ Object
97 98 99 |
# File 'lib/murmur/user.rb', line 97 def server @server end |
#session ⇒ Object Also known as: id
12 13 14 |
# File 'lib/murmur/user.rb', line 12 def session @user.session end |
#suppressed=(suppressed) ⇒ Object
47 48 49 50 |
# File 'lib/murmur/user.rb', line 47 def suppressed=(suppressed) @user.suppress = suppressed update end |
#suppressed? ⇒ Boolean
43 44 45 |
# File 'lib/murmur/user.rb', line 43 def suppressed? @user.suppress end |
#tcponly=(tcponly) ⇒ Object
159 160 161 162 |
# File 'lib/murmur/user.rb', line 159 def tcponly=(tcponly) @user.tcponly = tcponly update end |
#tcponly? ⇒ Boolean
155 156 157 |
# File 'lib/murmur/user.rb', line 155 def tcponly? @user.tcponly end |
#tcpPing ⇒ Object
172 173 174 |
# File 'lib/murmur/user.rb', line 172 def tcpPing ping[:tcp] end |
#udpPing ⇒ Object
168 169 170 |
# File 'lib/murmur/user.rb', line 168 def udpPing ping[:udp] end |
#userid ⇒ Object
17 18 19 |
# File 'lib/murmur/user.rb', line 17 def userid @user.userid end |
#version ⇒ Object
122 123 124 |
# File 'lib/murmur/user.rb', line 122 def version @user.version end |