Class: Twilio::REST::Insights::V1::RoomContext::ParticipantInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::Insights::V1::RoomContext::ParticipantInstance
- Defined in:
- lib/twilio-ruby/rest/insights/v1/room/participant.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
Account SID associated with the room.
-
#codecs ⇒ Array<Codec>
Codecs detected from the participant.
-
#context ⇒ ParticipantContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#duration_sec ⇒ String
Amount of time in seconds the participant was in the room.
- #edge_location ⇒ EdgeLocation
-
#end_reason ⇒ String
Reason the participant left the room.
-
#error_code ⇒ String
Errors encountered by the participant.
-
#error_code_url ⇒ String
Twilio error code dictionary link.
-
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance.
-
#initialize(version, payload, room_sid: nil, participant_sid: nil) ⇒ ParticipantInstance
constructor
Initialize the ParticipantInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#join_time ⇒ Time
When the participant joined the room.
-
#leave_time ⇒ Time
When the participant left the room.
- #media_region ⇒ TwilioRealm
-
#participant_identity ⇒ String
The application-defined string that uniquely identifies the participant within a Room.
-
#participant_sid ⇒ String
Unique identifier for the participant.
-
#properties ⇒ Hash
Object containing information about the participant’s data from the room.
-
#publisher_info ⇒ Hash
Object containing information about the SDK name and version.
-
#room_sid ⇒ String
Unique identifier for the room.
- #status ⇒ RoomStatus
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
URL of the participant resource.
Constructor Details
#initialize(version, payload, room_sid: nil, participant_sid: nil) ⇒ ParticipantInstance
Initialize the ParticipantInstance
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 216 def initialize(version, payload , room_sid: nil, participant_sid: nil) super(version) # Marshaled Properties @properties = { 'participant_sid' => payload['participant_sid'], 'participant_identity' => payload['participant_identity'], 'join_time' => Twilio.deserialize_iso8601_datetime(payload['join_time']), 'leave_time' => Twilio.deserialize_iso8601_datetime(payload['leave_time']), 'duration_sec' => payload['duration_sec'], 'account_sid' => payload['account_sid'], 'room_sid' => payload['room_sid'], 'status' => payload['status'], 'codecs' => payload['codecs'], 'end_reason' => payload['end_reason'], 'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i, 'error_code_url' => payload['error_code_url'], 'media_region' => payload['media_region'], 'properties' => payload['properties'], 'edge_location' => payload['edge_location'], 'publisher_info' => payload['publisher_info'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'room_sid' => room_sid || @properties['room_sid'] ,'participant_sid' => participant_sid || @properties['participant_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
288 289 290 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 288 def account_sid @properties['account_sid'] end |
#codecs ⇒ Array<Codec>
306 307 308 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 306 def codecs @properties['codecs'] end |
#context ⇒ ParticipantContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
249 250 251 252 253 254 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 249 def context unless @instance_context @instance_context = ParticipantContext.new(@version , @params['room_sid'], @params['participant_sid']) end @instance_context end |
#duration_sec ⇒ String
282 283 284 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 282 def duration_sec @properties['duration_sec'] end |
#edge_location ⇒ EdgeLocation
342 343 344 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 342 def edge_location @properties['edge_location'] end |
#end_reason ⇒ String
312 313 314 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 312 def end_reason @properties['end_reason'] end |
#error_code ⇒ String
318 319 320 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 318 def error_code @properties['error_code'] end |
#error_code_url ⇒ String
324 325 326 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 324 def error_code_url @properties['error_code_url'] end |
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance
361 362 363 364 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 361 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
375 376 377 378 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 375 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Insights.V1.ParticipantInstance #{values}>" end |
#join_time ⇒ Time
270 271 272 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 270 def join_time @properties['join_time'] end |
#leave_time ⇒ Time
276 277 278 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 276 def leave_time @properties['leave_time'] end |
#media_region ⇒ TwilioRealm
330 331 332 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 330 def media_region @properties['media_region'] end |
#participant_identity ⇒ String
264 265 266 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 264 def participant_identity @properties['participant_identity'] end |
#participant_sid ⇒ String
258 259 260 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 258 def participant_sid @properties['participant_sid'] end |
#properties ⇒ Hash
336 337 338 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 336 def properties @properties['properties'] end |
#publisher_info ⇒ Hash
348 349 350 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 348 def publisher_info @properties['publisher_info'] end |
#room_sid ⇒ String
294 295 296 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 294 def room_sid @properties['room_sid'] end |
#status ⇒ RoomStatus
300 301 302 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 300 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
368 369 370 371 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 368 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Insights.V1.ParticipantInstance #{values}>" end |
#url ⇒ String
354 355 356 |
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 354 def url @properties['url'] end |