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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Sync::V1::ServiceContext::SyncStreamInstance

Defined in:

lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #context ⇒ SyncStreamContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #created_by ⇒ String

  The Identity of the Stream’s creator.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the resource was created.

• #date_expires ⇒ Time

  The ISO 8601 date and time in GMT when the Message Stream expires.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the SyncStreamInstance.

• #fetch ⇒ SyncStreamInstance

  Fetch the SyncStreamInstance.

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

  Initialize the SyncStreamInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  The URLs of the Stream’s nested resources.

• #service_sid ⇒ String

  The SID of the Sync Service that the resource is associated with.

• #sid ⇒ String

  The unique string that identifies the resource.

• #stream_messages ⇒ stream_messages

  Access the stream_messages.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  An application-defined string that uniquely identifies the resource.

• #update(ttl: :unset) ⇒ SyncStreamInstance

  Update the SyncStreamInstance.

• #url ⇒ String

  The absolute URL of the Message Stream resource.

Constructor Details

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

Initialize the SyncStreamInstance

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

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

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

def account_sid
  @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

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

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

#created_by ⇒ String

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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncStreamInstance

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

def delete
  context.delete
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#links ⇒ String

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

def links
  @properties['links']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#stream_messages ⇒ stream_messages

Access the stream_messages

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

def stream_messages
  context.stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#unique_name ⇒ String

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

def unique_name
  @properties['unique_name']
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance

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

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

#url ⇒ String

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

def url
  @properties['url']
end