Class: SyncMapInstance

Twilio.Sync.V1.ServiceContext.SyncMapInstance(version, payload, serviceSid, sid)

new SyncMapInstance(version, payload, serviceSid, sid)

Initialize the SyncMapContext
Parameters:
Name Type Description
version V1 Version of the resource
payload SyncMapPayload The instance payload
serviceSid sid The SID of the Sync Service that the resource is associated with
sid sid_like The SID of the Sync Map resource to fetch
Properties:
Name Type Description
sid string The unique string that identifies the resource
uniqueName string An application-defined string that uniquely identifies the resource
accountSid string The SID of the Account that created the resource
serviceSid string The SID of the Sync Service that the resource is associated with
url string The absolute URL of the Sync Map resource
links string The URLs of the Sync Map's nested resources
revision string The current revision of the Sync Map, represented as a string
dateExpires Date The ISO 8601 date and time in GMT when the Sync Map expires
dateCreated Date The ISO 8601 date and time in GMT when the resource was created
dateUpdated Date The ISO 8601 date and time in GMT when the resource was last updated
createdBy string The identity of the Sync Map's creator
Source:

Methods

fetch(callbackopt) → {Promise}

fetch a SyncMapInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed SyncMapInstance
Type
Promise

remove(callbackopt) → {Promise}

remove a SyncMapInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed SyncMapInstance
Type
Promise

syncMapItems() → {Twilio.Sync.V1.ServiceContext.SyncMapContext.SyncMapItemList}

Access the syncMapItems
Source:
Returns:
Type
Twilio.Sync.V1.ServiceContext.SyncMapContext.SyncMapItemList

syncMapPermissions() → {Twilio.Sync.V1.ServiceContext.SyncMapContext.SyncMapPermissionList}

Access the syncMapPermissions
Source:
Returns:
Type
Twilio.Sync.V1.ServiceContext.SyncMapContext.SyncMapPermissionList

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object

update(optsopt, callbackopt) → {Promise}

update a SyncMapInstance
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
ttl number <optional>
 An alias for collection_ttl
collectionTtl number <optional>
 How long, in seconds, before the Sync Map expires and is deleted
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed SyncMapInstance
Type
Promise