Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update setMetadata docs to clarify merging. And whitespace issues #607

Merged
merged 1 commit into from
May 19, 2015
Merged

Update setMetadata docs to clarify merging. And whitespace issues #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions lib/storage/file.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,7 @@ File.prototype.getSignedPolicy = function(options, callback) {
* @param {string=} options.responseDisposition - The
* response-content-disposition parameter (http://goo.gl/yMWxQV) of the
* signed url.
* @param {string=} options.responseType - The response-content-type parameter
* @param {string=} options.responseType - The response-content-type parameter
* of the signed url.
* @param {function=} callback - The callback function.
*
Expand Down Expand Up @@ -1071,20 +1071,20 @@ File.prototype.getSignedUrl = function(options, callback) {

var responseContentType = '';
if (util.is(options.responseType, 'string')) {
responseContentType =
'&response-content-type=' +
responseContentType =
'&response-content-type=' +
encodeURIComponent(options.responseType);
}

var responseContentDisposition = '';
if (util.is(options.promptSaveAs, 'string')) {
responseContentDisposition =
'&response-content-disposition=attachment; filename="' +
'&response-content-disposition=attachment; filename="' +
encodeURIComponent(options.promptSaveAs) + '"';
}
if (util.is(options.responseDisposition, 'string')) {
responseContentDisposition =
'&response-content-disposition=' +
responseContentDisposition =
'&response-content-disposition=' +
encodeURIComponent(options.responseDisposition);
}

Expand All @@ -1100,9 +1100,17 @@ File.prototype.getSignedUrl = function(options, callback) {
};

/**
* Set the file's metadata.
* Merge the given metadata with the current remote file's metadata. This will
* set metadata if it was previously unset or update previously set metadata. To
* unset previously set metadata, set its value to null.
*
* You can set custom key/value pairs in the metadata key of the given object,
* however the other properties outside of this object must adhere to the
* [official API documentation](https://goo.gl/BOnnCK).
*
* @param {object} metadata - The metadata you wish to set.
* See the examples below for more information.
*
* @param {object} metadata - The metadata you wish to update.
* @param {function=} callback - The callback function.
*
* @example
Expand All @@ -1113,6 +1121,17 @@ File.prototype.getSignedUrl = function(options, callback) {
* properties: 'go here'
* }
* }, function(err, metadata, apiResponse) {});
*
* // Assuming current metadata = { hello: 'world', unsetMe: 'will do' }
* file.setMetadata({
* metadata: {
* abc: '123', // will be set.
* unsetMe: null, // will be unset (deleted).
* hello: 'goodbye' // will be updated from 'hello' to 'goodbye'.
* }
* }, function(err, metadata, apiResponse) {
* // metadata should now be { abc: '123', hello: 'goodbye' }
* });
*/
File.prototype.setMetadata = function(metadata, callback) {
callback = callback || util.noop;
Expand Down