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

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

Overview

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

Defined Under Namespace

Classes: SyncMapItemContext, SyncMapItemInstance, SyncMapItemList, SyncMapItemPage, SyncMapPermissionContext, SyncMapPermissionInstance, SyncMapPermissionList, SyncMapPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncMapContext

Initialize the SyncMapContext

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 Map resource to fetch.

  • sid (String) —

    The SID of the Sync Map resource to fetch.



192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 192

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

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

  # Dependents
  @sync_map_items = nil
  @sync_map_permissions = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the SyncMapInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

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

#fetch ⇒ SyncMapInstance

Fetch a SyncMapInstance

Returns:



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 207

def fetch
  params = Twilio::Values.of({})

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



300
301
302
303
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 300

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

#sync_map_items(key = :unset) ⇒ SyncMapItemList, SyncMapItemContext

Access the sync_map_items

Returns:

Raises:

  • (ArgumentError) 


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

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

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

  unless @sync_map_items
    @sync_map_items = SyncMapItemList.new(
        @version,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:sid],
    )
  end

  @sync_map_items
end

#sync_map_permissions(identity = :unset) ⇒ SyncMapPermissionList, SyncMapPermissionContext

Access the sync_map_permissions

Returns:

Raises:

  • (ArgumentError) 


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

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

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

  unless @sync_map_permissions
    @sync_map_permissions = SyncMapPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:sid],
    )
  end

  @sync_map_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



293
294
295
296
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 293

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

#update(ttl: :unset, collection_ttl: :unset) ⇒ SyncMapInstance

Update the SyncMapInstance

Parameters:

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

    An alias for ‘collection_ttl`. If both parameters are provided, this value is ignored.

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

    How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the Sync Map does not expire. The Sync Map might not be deleted immediately after it expires.

Returns:



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 235

def update(ttl: :unset, collection_ttl: :unset)
  data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })

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

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