Class: Twilio::REST::Sync::V1::ServiceContext::SyncStreamInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ SyncStreamInstance

Initialize the SyncStreamInstance

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 SyncStream resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 302

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
        'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Sync Stream resource.

Returns:



349
350
351
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 349

def 
    @properties['account_sid']
end

#context ⇒ SyncStreamContext

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

Returns:



328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 328

def context
    unless @instance_context
        @instance_context = SyncStreamContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#created_by ⇒ String

Returns The identity of the Stream’s creator. If the Stream is created from the client SDK, the value matches the Access Token’s ‘identity` field. If the Stream was created from the REST API, the value is ’system’.

Returns:

  • (String) —

    The identity of the Stream’s creator. If the Stream is created from the client SDK, the value matches the Access Token’s ‘identity` field. If the Stream was created from the REST API, the value is ’system’.



391
392
393
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 391

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



379
380
381
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 379

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

Returns The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is ‘null`. The Stream might not be deleted immediately after it expires.

Returns:

  • (Time) —

    The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is ‘null`. The Stream might not be deleted immediately after it expires.



373
374
375
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 373

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



385
386
387
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 385

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncStreamInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



398
399
400
401
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 398

def delete

    context.delete
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance

Returns:



406
407
408
409
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 406

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



440
441
442
443
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 440

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

#links ⇒ Hash

Returns The URLs of the Stream’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Stream’s nested resources.



367
368
369
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 367

def links
    @properties['links']
end

#service_sid ⇒ String

Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

Returns:



355
356
357
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 355

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Sync Stream resource.

Returns:

  • (String) —

    The unique string that we created to identify the Sync Stream resource.



337
338
339
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 337

def sid
    @properties['sid']
end

#stream_messages ⇒ stream_messages

Access the stream_messages

Returns:



427
428
429
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 427

def stream_messages
    context.stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



433
434
435
436
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 433

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.



343
344
345
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 343

def unique_name
    @properties['unique_name']
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance

Parameters:

Returns:



415
416
417
418
419
420
421
422
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 415

def update(
    ttl: :unset
)

    context.update(
        ttl: ttl, 
    )
end

#url ⇒ String

Returns The absolute URL of the Message Stream resource.

Returns:

  • (String) —

    The absolute URL of the Message Stream resource.



361
362
363
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 361

def url
    @properties['url']
end