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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    The unique SID identifier of the Service Instance that hosts this Message Stream.

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

    Identifier of the Stream. Either a SID or a unique name.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 283

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Twilio Account SID.

Returns:

  • (String) —

    Twilio Account SID.



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

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:



309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 309

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

#created_by ⇒ String

Returns Identity of the Stream creator.

Returns:

  • (String) —

    Identity of the Stream creator.



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date this Stream was created.

Returns:

  • (Time) —

    The date this Stream was created.



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns The date this Stream expires.

Returns:

  • (Time) —

    The date this Stream expires.



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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

Returns The date this Stream was updated.

Returns:

  • (Time) —

    The date this Stream was updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncStreamInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncStreamInstance

Fetch a SyncStreamInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



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

def links
  @properties['links']
end

#service_sid ⇒ String

Returns Service Instance SID.

Returns:

  • (String) —

    Service Instance SID.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns Stream SID.

Returns:

  • (String) —

    Stream SID.



318
319
320
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 318

def sid
  @properties['sid']
end

#stream_messages ⇒ stream_messages

Access the stream_messages

Returns:



402
403
404
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 402

def stream_messages
  context.stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns Stream unique name.

Returns:

  • (String) —

    Stream unique name.



324
325
326
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 324

def unique_name
  @properties['unique_name']
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance

Parameters:

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

    New time-to-live of this Stream in seconds. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

Returns:



395
396
397
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 395

def update(ttl: :unset)
  context.update(ttl: ttl, )
end

#url ⇒ String

Returns URL of this Stream.

Returns:

  • (String) —

    URL of this Stream.



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

def url
  @properties['url']
end