Class: Twilio::REST::Chat::V1::ServiceContext::UserContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/service/user.rb,
lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb

Defined Under Namespace

Classes: UserChannelInstance, UserChannelList, UserChannelPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ UserContext

Initialize the UserContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Service to fetch the resource from.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the User resource to fetch.


184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 184

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

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

  # Dependents
  @user_channels = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


207
208
209
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 207

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

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:


198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 198

def fetch
  payload = @version.fetch('GET', @uri)

  UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


257
258
259
260
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 257

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

#to_s ⇒ Object

Provide a user friendly representation


250
251
252
253
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 250

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

#update(role_sid: :unset, attributes: :unset, friendly_name: :unset) ⇒ UserInstance

Update the UserInstance

Parameters:

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

    The SID of the Role assigned to this user.

  • attributes (String) (defaults to: :unset) —

    A valid JSON string that contains application-specific data.

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It is often used for display purposes.

Returns:


220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 220

def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
  data = Twilio::Values.of({
      'RoleSid' => role_sid,
      'Attributes' => attributes,
      'FriendlyName' => friendly_name,
  })

  payload = @version.update('POST', @uri, data: data)

  UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#user_channels ⇒ UserChannelList, UserChannelContext

Access the user_channels

Returns:


236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 236

def user_channels
  unless @user_channels
    @user_channels = UserChannelList.new(
        @version,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:sid],
    )
  end

  @user_channels
end