class Twilio::REST::Api::V2010::AccountContext::QueueContext::MemberInstance
Public Class Methods
Initialize the MemberInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] account_sid The SID of the
{Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue resource.
@param [String] queue_sid
The SID of the Queue the member is in. @param [String] call_sid
The
{Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resource(s) to fetch.
@return [MemberInstance] MemberInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 238 def initialize(version, payload, account_sid: nil, queue_sid: nil, call_sid: nil) 239 super(version) 240 241 # Marshaled Properties 242 @properties = { 243 'call_sid' => payload['call_sid'], 244 'date_enqueued' => Twilio.deserialize_rfc2822(payload['date_enqueued']), 245 'position' => payload['position'].to_i, 246 'uri' => payload['uri'], 247 'wait_time' => payload['wait_time'].to_i, 248 'queue_sid' => payload['queue_sid'], 249 } 250 251 # Context 252 @instance_context = nil 253 @params = { 254 'account_sid' => account_sid, 255 'queue_sid' => queue_sid, 256 'call_sid' => call_sid || @properties['call_sid'], 257 } 258 end
Public Instance Methods
@return [String] The SID of the Call the resource is associated with
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 278 def call_sid 279 @properties['call_sid'] 280 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [MemberContext] MemberContext
for this MemberInstance
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 264 def context 265 unless @instance_context 266 @instance_context = MemberContext.new( 267 @version, 268 @params['account_sid'], 269 @params['queue_sid'], 270 @params['call_sid'], 271 ) 272 end 273 @instance_context 274 end
@return [Time] The date the member was enqueued
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 284 def date_enqueued 285 @properties['date_enqueued'] 286 end
Fetch the MemberInstance
@return [MemberInstance] Fetched MemberInstance
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 315 def fetch 316 context.fetch 317 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 339 def inspect 340 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 341 "<Twilio.Api.V2010.MemberInstance #{values}>" 342 end
@return [String] This member's current position in the queue.
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 290 def position 291 @properties['position'] 292 end
@return [String] The SID of the Queue the member is in
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 308 def queue_sid 309 @properties['queue_sid'] 310 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 332 def to_s 333 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 334 "<Twilio.Api.V2010.MemberInstance #{values}>" 335 end
Update the MemberInstance
@param [String] url The absolute URL of the Queue resource. @param [String] method How to pass the update request data. Can be `GET` or
`POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.
@return [MemberInstance] Updated MemberInstance
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 326 def update(url: nil, method: :unset) 327 context.update(url: url, method: method, ) 328 end
@return [String] The URI of the resource, relative to `api.twilio.com`
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 296 def uri 297 @properties['uri'] 298 end
@return [String] The number of seconds the member has been in the queue.
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 302 def wait_time 303 @properties['wait_time'] 304 end