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.



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

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



174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 174

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 184

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.fetch('GET', @uri, headers: headers)
    SyncStreamInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 241

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:



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

def stream_messages
  unless @stream_messages
    @stream_messages = StreamMessageList.new(
            @version, )
  end
  @stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 201

def update(
    ttl: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    SyncStreamInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end