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

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

Defined Under Namespace

Classes: DocumentPermissionContext, DocumentPermissionInstance, DocumentPermissionList, DocumentPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ DocumentContext

Initialize the DocumentContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The SID of the Sync Service with the Document resource to fetch.

  • sid (String)

    The SID of the Document resource to fetch. Can be the Document resource's `sid` or its `unique_name`.


178
179
180
181
182
183
184
185
186
187
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 178

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

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

  # Dependents
  @document_permissions = nil
end

Instance Method Details

#deleteBoolean

Delete the DocumentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


201
202
203
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 201

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

#document_permissions(identity = :unset) ⇒ DocumentPermissionList, DocumentPermissionContext

Access the document_permissions

Returns:

Raises:

  • (ArgumentError)

227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 227

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

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

  unless @document_permissions
    @document_permissions = DocumentPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        document_sid: @solution[:sid],
    )
  end

  @document_permissions
end

#fetchDocumentInstance

Fetch the DocumentInstance

Returns:


192
193
194
195
196
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 192

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

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

#inspectObject

Provide a detailed, user friendly representation


254
255
256
257
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 254

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

#to_sObject

Provide a user friendly representation


247
248
249
250
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 247

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

#update(data: :unset, ttl: :unset, if_match: :unset) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

  • data (Hash) (defaults to: :unset)

    A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

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

    How long, in seconds, before the Sync Document expires and is deleted (time-to-live).

  • if_match (String) (defaults to: :unset)

    The If-Match HTTP request header

Returns:


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

def update(data: :unset, ttl: :unset, if_match: :unset)
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
  headers = Twilio::Values.of({'If-Match' => if_match, })

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

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