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

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 update.

  • sid (String) —

    The SID of the Sync Map resource to update. Can be the Sync Map’s ‘sid` or its `unique_name`.



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 171

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

Delete the SyncMapInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

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

#fetch ⇒ SyncMapInstance

Fetch the SyncMapInstance

Returns:



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

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 248

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) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 267

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



285
286
287
288
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 285

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](www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted.

Returns:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 219

def update(
    ttl: :unset, 
    collection_ttl: :unset
)

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

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