class Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::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] service_sid
The service_sid
@param [String] channel_sid
The channel_sid
@param [String] sid The sid @return [MemberInstance] MemberInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 257 def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) 258 super(version) 259 260 # Marshaled Properties 261 @properties = { 262 'sid' => payload['sid'], 263 'account_sid' => payload['account_sid'], 264 'channel_sid' => payload['channel_sid'], 265 'service_sid' => payload['service_sid'], 266 'identity' => payload['identity'], 267 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 268 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 269 'role_sid' => payload['role_sid'], 270 'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i, 271 'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']), 272 'url' => payload['url'], 273 } 274 275 # Context 276 @instance_context = nil 277 @params = { 278 'service_sid' => service_sid, 279 'channel_sid' => channel_sid, 280 'sid' => sid || @properties['sid'], 281 } 282 end
Public Instance Methods
@return [String] The account_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 308 def account_sid 309 @properties['account_sid'] 310 end
@return [String] The channel_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 314 def channel_sid 315 @properties['channel_sid'] 316 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/ip_messaging/v1/service/channel/member.rb 288 def context 289 unless @instance_context 290 @instance_context = MemberContext.new( 291 @version, 292 @params['service_sid'], 293 @params['channel_sid'], 294 @params['sid'], 295 ) 296 end 297 @instance_context 298 end
@return [Time] The date_created
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 332 def date_created 333 @properties['date_created'] 334 end
@return [Time] The date_updated
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 338 def date_updated 339 @properties['date_updated'] 340 end
Delete the MemberInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 376 def delete 377 context.delete 378 end
Fetch the MemberInstance
@return [MemberInstance] Fetched MemberInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 369 def fetch 370 context.fetch 371 end
@return [String] The identity
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 326 def identity 327 @properties['identity'] 328 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 398 def inspect 399 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 400 "<Twilio.IpMessaging.V1.MemberInstance #{values}>" 401 end
@return [String] The last_consumed_message_index
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 350 def last_consumed_message_index 351 @properties['last_consumed_message_index'] 352 end
@return [Time] The last_consumption_timestamp
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 356 def last_consumption_timestamp 357 @properties['last_consumption_timestamp'] 358 end
@return [String] The role_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 344 def role_sid 345 @properties['role_sid'] 346 end
@return [String] The service_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 320 def service_sid 321 @properties['service_sid'] 322 end
@return [String] The sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 302 def sid 303 @properties['sid'] 304 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 391 def to_s 392 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 393 "<Twilio.IpMessaging.V1.MemberInstance #{values}>" 394 end
Update the MemberInstance
@param [String] role_sid
The role_sid
@param [String] last_consumed_message_index
The last_consumed_message_index
@return [MemberInstance] Updated MemberInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 385 def update(role_sid: :unset, last_consumed_message_index: :unset) 386 context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, ) 387 end
@return [String] The url
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb 362 def url 363 @properties['url'] 364 end