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 collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Sync Stream 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 date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_expires ⇒ 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.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#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 ⇒ Hash
The URLs of the Stream’s nested resources.
-
#service_sid ⇒ String
The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the Sync Stream 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
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 277 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.
324 325 326 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 324 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
303 304 305 306 307 308 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 303 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’.
366 367 368 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 366 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.
354 355 356 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 354 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.
348 349 350 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 348 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.
360 361 362 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 360 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the SyncStreamInstance
373 374 375 376 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 373 def delete context.delete end |
#fetch ⇒ SyncStreamInstance
Fetch the SyncStreamInstance
381 382 383 384 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 381 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 ⇒ Hash
Returns The URLs of the Stream’s nested resources.
342 343 344 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 342 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.
330 331 332 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 330 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Sync Stream resource.
312 313 314 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 312 def sid @properties['sid'] end |
#stream_messages ⇒ stream_messages
Access the stream_messages
402 403 404 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 402 def context. 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 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.
318 319 320 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 318 def unique_name @properties['unique_name'] end |
#update(ttl: :unset) ⇒ SyncStreamInstance
Update the SyncStreamInstance
390 391 392 393 394 395 396 397 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 390 def update( ttl: :unset ) context.update( ttl: ttl, ) end |
#url ⇒ String
Returns The absolute URL of the Message Stream resource.
336 337 338 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 336 def url @properties['url'] end |