Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::MemberContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ MemberContext

Initialize the MemberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • channel_sid (String)
  • sid (String) 


168
169
170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 168

def initialize(version, service_sid, channel_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the MemberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



180
181
182
183
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 180

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 188

def fetch

    payload = @version.fetch('GET', @uri)
    MemberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



235
236
237
238
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 235

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



228
229
230
231
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 228

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
end

#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

  • role_sid (String) (defaults to: :unset)
  • last_consumed_message_index (String) (defaults to: :unset)

Returns:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 205

def update(
    role_sid: :unset, 
    last_consumed_message_index: :unset
)

    data = Twilio::Values.of({
        'RoleSid' => role_sid,
        'LastConsumedMessageIndex' => last_consumed_message_index,
    })

    payload = @version.update('POST', @uri, data: data)
    MemberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end