class Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MemberContext
Public Class Methods
Initialize the MemberContext
@param [Version] version Version
that contains the resource @param [String] service_sid The service_sid @param [String] channel_sid The channel_sid @param [String] sid The sid @return [MemberContext] MemberContext
Twilio::REST::InstanceContext::new
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 197 def initialize(version, service_sid, channel_sid, sid) 198 super(version) 199 200 # Path Solution 201 @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, } 202 @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}" 203 end
Public Instance Methods
Delete the MemberInstance
@param [member.WebhookEnabledType] x_twilio_webhook_enabled The
X-Twilio-Webhook-Enabled HTTP request header
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 225 def delete(x_twilio_webhook_enabled: :unset) 226 headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) 227 228 @version.delete('DELETE', @uri, headers: headers) 229 end
Fetch the MemberInstance
@return [MemberInstance] Fetched MemberInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 208 def fetch 209 payload = @version.fetch('GET', @uri) 210 211 MemberInstance.new( 212 @version, 213 payload, 214 service_sid: @solution[:service_sid], 215 channel_sid: @solution[:channel_sid], 216 sid: @solution[:sid], 217 ) 218 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 273 def inspect 274 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 275 "#<Twilio.IpMessaging.V2.MemberContext #{context}>" 276 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 266 def to_s 267 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 268 "#<Twilio.IpMessaging.V2.MemberContext #{context}>" 269 end
Update the MemberInstance
@param [String] role_sid The role_sid @param [String] last_consumed_message_index The last_consumed_message_index @param [Time] last_consumption_timestamp The last_consumption_timestamp @param [Time] date_created The date_created @param [Time] date_updated The date_updated @param [String] attributes The attributes @param [member.WebhookEnabledType] x_twilio_webhook_enabled The
X-Twilio-Webhook-Enabled HTTP request header
@return [MemberInstance] Updated MemberInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb 242 def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) 243 data = Twilio::Values.of({ 244 'RoleSid' => role_sid, 245 'LastConsumedMessageIndex' => last_consumed_message_index, 246 'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp), 247 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 248 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 249 'Attributes' => attributes, 250 }) 251 headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) 252 253 payload = @version.update('POST', @uri, data: data, headers: headers) 254 255 MemberInstance.new( 256 @version, 257 payload, 258 service_sid: @solution[:service_sid], 259 channel_sid: @solution[:channel_sid], 260 sid: @solution[:sid], 261 ) 262 end