Package com.twilio.rest.sync.v1.service.synclist

Class SyncListItemUpdater

java.lang.Object

com.twilio.base.Updater<SyncListItem>

com.twilio.rest.sync.v1.service.synclist.SyncListItemUpdater

public class SyncListItemUpdater
extends Updater<SyncListItem>

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

Constructor Summary

Constructors

Constructor	Description
SyncListItemUpdater(String pathServiceSid, String pathListSid, Integer pathIndex)	Construct a new SyncListItemUpdater.

Method Summary

Modifier and Type	Method	Description
SyncListItemUpdater	setCollectionTtl(Integer collectionTtl)	How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted.
SyncListItemUpdater	setData(Map<String,Object> data)	A JSON string that represents an arbitrary, schema-less object that the List Item stores.
SyncListItemUpdater	setItemTtl(Integer itemTtl)	How long, in seconds, before the List Item expires (time-to-live) and is deleted.
SyncListItemUpdater	setTtl(Integer ttl)	An alias for `item_ttl`.
SyncListItem	update(TwilioRestClient client)	Make the request to the Twilio API to perform the update.

Methods inherited from class com.twilio.base.Updater

update, updateAsync, updateAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncListItemUpdater

public SyncListItemUpdater(String pathServiceSid,
                           String pathListSid,
                           Integer pathIndex)

Construct a new SyncListItemUpdater.

Parameters:

pathServiceSid - The SID of the Sync Service with the Sync List Item resource to update

pathListSid - The SID of the Sync List with the Sync List Item resource to update

pathIndex - The index of the Sync List Item resource to update

Method Detail

setData

public SyncListItemUpdater setData(Map<String,Object> data)

A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB in length..

Parameters:

data - A JSON string that represents an arbitrary, schema-less object that the List Item stores

Returns:

this

setTtl

public SyncListItemUpdater setTtl(Integer ttl)

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

Parameters:

ttl - An alias for item_ttl

Returns:

this

setItemTtl

public SyncListItemUpdater setItemTtl(Integer itemTtl)

How long, in seconds, before the List Item 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 List Item does not expire. The List Item might not be deleted immediately after it expires..

Parameters:

itemTtl - How long, in seconds, before the List Item expires

Returns:

this

setCollectionTtl

public SyncListItemUpdater setCollectionTtl(Integer collectionTtl)

How long, in seconds, before the List Item's parent Sync List 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 parent Sync List does not expire. The Sync List might not be deleted immediately after it expires..

Parameters:

collectionTtl - How long, in seconds, before the List Item's parent Sync List expires

Returns:

this

update

public SyncListItem update(TwilioRestClient client)

Make the request to the Twilio API to perform the update.

Specified by:

update in class Updater<SyncListItem>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Updated SyncListItem