Class: Twilio::REST::Sync::V1::ServiceContext::SyncStreamContext

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

Defined Under Namespace

Classes: StreamMessageInstance, StreamMessageList, StreamMessagePage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncStreamContext

Initialize the SyncStreamContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) with the Sync Stream resource to update.

  • sid (String) —

    The SID of the Stream resource to update.



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 159

def initialize(version, service_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Streams/#{@solution[:sid]}"

    # Dependents
    @stream_messages = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncStreamInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



172
173
174
175
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 172

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance

Returns:



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 180

def fetch

    payload = @version.fetch('GET', @uri)
    SyncStreamInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



233
234
235
236
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 233

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Sync.V1.SyncStreamContext #{context}>"
end

#stream_messages ⇒ StreamMessageList, StreamMessageContext

Access the stream_messages

Returns:



216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 216

def stream_messages
  unless @stream_messages
    @stream_messages = StreamMessageList.new(
            @version, service_sid: @solution[:service_sid],  stream_sid: @solution[:sid],  )
  end
  @stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



226
227
228
229
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 226

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Sync.V1.SyncStreamContext #{context}>"
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance

Parameters:

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 195

def update(
    ttl: :unset
)

    data = Twilio::Values.of({
        'Ttl' => ttl,
    })

    payload = @version.update('POST', @uri, data: data)
    SyncStreamInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end