class Twilio::REST::IpMessaging::V1::ServiceContext::UserContext

Public Class Methods

new(version, service_sid, sid) click to toggle source

Initialize the UserContext @param [Version] version Version that contains the resource @param [String] service_sid The service_sid @param [String] sid The sid @return [UserContext] UserContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
171 def initialize(version, service_sid, sid)
172   super(version)
173 
174   # Path Solution
175   @solution = {service_sid: service_sid, sid: sid, }
176   @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:sid]}"
177 
178   # Dependents
179   @user_channels = nil
180 end

Public Instance Methods

delete() click to toggle source

Delete the UserInstance @return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
194 def delete
195    @version.delete('DELETE', @uri)
196 end
fetch() click to toggle source

Fetch the UserInstance @return [UserInstance] Fetched UserInstance

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
185 def fetch
186   payload = @version.fetch('GET', @uri)
187 
188   UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
189 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
241 def inspect
242   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
243   "#<Twilio.IpMessaging.V1.UserContext #{context}>"
244 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
234 def to_s
235   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
236   "#<Twilio.IpMessaging.V1.UserContext #{context}>"
237 end
update(role_sid: :unset, attributes: :unset, friendly_name: :unset) click to toggle source

Update the UserInstance @param [String] role_sid The role_sid @param [String] attributes The attributes @param [String] friendly_name The friendly_name @return [UserInstance] Updated UserInstance

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
204 def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
205   data = Twilio::Values.of({
206       'RoleSid' => role_sid,
207       'Attributes' => attributes,
208       'FriendlyName' => friendly_name,
209   })
210 
211   payload = @version.update('POST', @uri, data: data)
212 
213   UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
214 end
user_channels() click to toggle source

Access the user_channels @return [UserChannelList] @return [UserChannelContext]

    # File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb
220 def user_channels
221   unless @user_channels
222     @user_channels = UserChannelList.new(
223         @version,
224         service_sid: @solution[:service_sid],
225         user_sid: @solution[:sid],
226     )
227   end
228 
229   @user_channels
230 end