Class: Twilio::REST::Microvisor::V1::DeviceContext::DeviceConfigInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, device_sid: nil, key: nil) ⇒ DeviceConfigInstance

Initialize the DeviceConfigInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String)

    The SID of the Account that created this DeviceConfig resource.

  • sid (String)

    The SID of the Call resource to fetch.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 266

def initialize(version, payload , device_sid: nil, key: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'device_sid' => payload['device_sid'],
        'key' => payload['key'],
        'value' => payload['value'],
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'device_sid' => device_sid  || @properties['device_sid']  ,'key' => key  || @properties['key']  , }
end

Instance Method Details

#contextDeviceConfigContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



287
288
289
290
291
292
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 287

def context
    unless @instance_context
        @instance_context = DeviceConfigContext.new(@version , @params['device_sid'], @params['key'])
    end
    @instance_context
end

#date_updatedTime

Returns:

  • (Time)


314
315
316
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 314

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the DeviceConfigInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



327
328
329
330
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 327

def delete

    context.delete
end

#device_sidString

Returns A 34-character string that uniquely identifies the parent Device.

Returns:

  • (String)

    A 34-character string that uniquely identifies the parent Device.



296
297
298
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 296

def device_sid
    @properties['device_sid']
end

#fetchDeviceConfigInstance

Fetch the DeviceConfigInstance

Returns:



335
336
337
338
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 335

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



362
363
364
365
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 362

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Microvisor.V1.DeviceConfigInstance #{values}>"
end

#keyString

Returns The config key; up to 100 characters.

Returns:

  • (String)

    The config key; up to 100 characters.



302
303
304
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 302

def key
    @properties['key']
end

#to_sObject

Provide a user friendly representation



355
356
357
358
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 355

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Microvisor.V1.DeviceConfigInstance #{values}>"
end

#update(value: nil) ⇒ DeviceConfigInstance

Update the DeviceConfigInstance

Parameters:

  • value (String) (defaults to: nil)

    The config value; up to 4096 characters.

Returns:



344
345
346
347
348
349
350
351
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 344

def update(
    value: nil
)

    context.update(
        value: value, 
    )
end

#urlString

Returns The absolute URL of the Config.

Returns:

  • (String)

    The absolute URL of the Config.



320
321
322
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 320

def url
    @properties['url']
end

#valueString

Returns The config value; up to 4096 characters.

Returns:

  • (String)

    The config value; up to 4096 characters.



308
309
310
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 308

def value
    @properties['value']
end