Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

SharedResourceUnsharedDate Property

The date at which the resource will no longer be shared.

Syntax

 box.getSharedResourceUnsharedDate([callback])
 box.setSharedResourceUnsharedDate( sharedResourceUnsharedDate, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSharedResourceUnsharedDate([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSharedResourceUnsharedDate([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The date at which the resource will no longer be shared.

This value may optionally be set to specify the day on which the resource will no longer be shared. This setting may only be set if the account is a paid account. Timestamps are rounded off to the provided day.

Dates are formatted as RFC 3399 timestamps. When specifying a date in a request it should be converted to UTC for instance:

2016-04-17T09:12:36-00:00
Dates returned in responses may contain an offset. For instance:
2016-03-02T13:40:24-08:00

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0