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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service.rb,
lib/twilio-ruby/rest/sync/v1/service/document.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb,
lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb

Overview

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

Defined Under Namespace

Classes: DocumentContext, DocumentInstance, DocumentList, DocumentPage, SyncListContext, SyncListInstance, SyncListList, SyncListPage, SyncMapContext, SyncMapInstance, SyncMapList, SyncMapPage, SyncStreamContext, SyncStreamInstance, SyncStreamList, SyncStreamPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Service resource to fetch.



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

def initialize(version, sid)
  super(version)

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

  # Dependents
  @documents = nil
  @sync_lists = nil
  @sync_maps = nil
  @sync_streams = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



223
224
225
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 223

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

#documents(sid = :unset) ⇒ DocumentList, DocumentContext

Access the documents

Returns:

Raises:

  • (ArgumentError) 


274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 274

def documents(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return DocumentContext.new(@version, @solution[:sid], sid, )
  end

  unless @documents
    @documents = DocumentList.new(@version, service_sid: @solution[:sid], )
  end

  @documents
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 214

def fetch
  payload = @version.fetch('GET', @uri)

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sync_lists(sid = :unset) ⇒ SyncListList, SyncListContext

Access the sync_lists

Returns:

Raises:

  • (ArgumentError) 


292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 292

def sync_lists(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return SyncListContext.new(@version, @solution[:sid], sid, )
  end

  unless @sync_lists
    @sync_lists = SyncListList.new(@version, service_sid: @solution[:sid], )
  end

  @sync_lists
end

#sync_maps(sid = :unset) ⇒ SyncMapList, SyncMapContext

Access the sync_maps

Returns:

Raises:

  • (ArgumentError) 


310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 310

def sync_maps(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return SyncMapContext.new(@version, @solution[:sid], sid, )
  end

  unless @sync_maps
    @sync_maps = SyncMapList.new(@version, service_sid: @solution[:sid], )
  end

  @sync_maps
end

#sync_streams(sid = :unset) ⇒ SyncStreamList, SyncStreamContext

Access the sync_streams

Returns:

Raises:

  • (ArgumentError) 


328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 328

def sync_streams(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return SyncStreamContext.new(@version, @solution[:sid], sid, )
  end

  unless @sync_streams
    @sync_streams = SyncStreamList.new(@version, service_sid: @solution[:sid], )
  end

  @sync_streams
end

#to_s ⇒ Object

Provide a user friendly representation



344
345
346
347
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 344

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

#update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    The URL we should call when Sync objects are manipulated.

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

    A string that you assign to describe the resource.

  • reachability_webhooks_enabled (Boolean) (defaults to: :unset) —

    Whether the service instance should call ‘webhook_url` when client endpoints connect to Sync. The default is `false`.

  • acl_enabled (Boolean) (defaults to: :unset) —

    Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](www.twilio.com/docs/sync/api/sync-permissions) resource.

  • reachability_debouncing_enabled (Boolean) (defaults to: :unset) —

    Whether every ‘endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.

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

    The reachability event delay in milliseconds if ‘reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.

  • webhooks_from_rest_enabled (Boolean) (defaults to: :unset) —

    Whether the Service instance should call ‘webhook_url` when the REST API is used to update Sync objects. The default is `false`.

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 254

def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
  data = Twilio::Values.of({
      'WebhookUrl' => webhook_url,
      'FriendlyName' => friendly_name,
      'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled,
      'AclEnabled' => acl_enabled,
      'ReachabilityDebouncingEnabled' => reachability_debouncing_enabled,
      'ReachabilityDebouncingWindow' => reachability_debouncing_window,
      'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
  })

  payload = @version.update('POST', @uri, data: data)

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end