{"_id":"56c41cdd54b6030d00ec29ac","category":{"_id":"56c4183bbb64720d00552b88","__v":6,"pages":["56c41cc5521f350d00d34901","56c41ccf54b6030d00ec29aa","56c41cdd54b6030d00ec29ac","56c41ce7106c12170020dba4","56c41cee2d97560d00e23cff","56c41cf72d97560d00e23d01"],"project":"56bc8e679afb8b0d00d62dcf","version":"56bc8e689afb8b0d00d62dd2","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:35.303Z","from_sync":false,"order":4,"slug":"metadata","title":"Metadata"},"parentDoc":null,"project":"56bc8e679afb8b0d00d62dcf","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":4,"githubsync":"","user":"56b98db7bb36440d0001f492","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T07:10:21.400Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"/metadata/{id}/{key}/increment\"\n}\n[/block]\nIncrements a metadata value.  This value must be of a numeric type for this operation to succeed.\n\nThe default increment value is `1`. The `delta` parameter allows you to specify any desired increment including negative values.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\tdelta: 3,\\n\\tvisibility: \\\"App\\\"\\n};\\n\\nBuddy.post('/metadata/my_id/my_key/increment',\\n\\t\\toptions,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"NSDictionary *params = :::at:::{\\n\\t\\t\\[email protected]\\\"delta\\\": 3,\\n\\t\\t\\[email protected]\\\"visibility\\\": @\\\"App\\\"\\n\\t\\t};\\n\\n[Buddy POST:@\\\"/metadata/my_id/my_key/increment\\\" parameters:params class:[BPMetadataItem class] callback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Map<String, Object> parameters = new HashMap<String, Object>();\\nparameters.put(\\\"delta\\\", 3);\\nparameters.put(\\\"visibility\\\", \\\"App\\\");\\n\\nBuddy.<MetadataItem>post(\\\"/metadata/my_id/my_key/increment\\\", parameters, new BuddyCallback<MetadataItem>(MetadataItem.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<MetadataItem> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var options = new {\\n\\t\\t\\tdelta = 3,\\n\\t\\t\\tvisibility = \\\"App\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.PostAsync<MetadataItem>(\\\"/metadata/my_id/my_key/increment\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Path Parameters\n\nThese parameters should be specified as part of the HTTP path.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"0-1\": \"The ID of the Buddy object or application containing the target metadata.\",\n    \"0-2\": \"buddyId\",\n    \"1-0\": \"key\",\n    \"1-1\": \"The key of the metadata value to increment.\",\n    \"1-2\": \"string\",\n    \"0-3\": \"Required\",\n    \"1-3\": \"Required\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"delta\",\n    \"1-0\": \"visibility\",\n    \"0-1\": \"Any positive or negative integer to modify the metadata value by. Defaults to 1.\",\n    \"1-1\": \"Specifies the visibility of this item. Values are User, which means only the user that created the value can access or modify it, or App, which allows any app code to view the value.\",\n    \"0-2\": \"number\",\n    \"1-2\": \"string\",\n    \"0-3\": \"Optional\",\n    \"1-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"status\\\": 200,\\n    \\\"result\\\": {\\n        \\\"key\\\": \\\"likes\\\",\\n        \\\"value\\\": 1,\\n        \\\"created\\\": \\\"/Date(1393548751000)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1393548685057)/\\\"\\n    },\\n    \\\"request_id\\\": \\\"4cd28867-c25d-4236-8bc4-02d31a16f567\\\",\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"increment-metadata-values","type":"basic","title":"Increment Metadata Values"}

Increment Metadata Values


[block:api-header] { "type": "post", "title": "/metadata/{id}/{key}/increment" } [/block] Increments a metadata value. This value must be of a numeric type for this operation to succeed. The default increment value is `1`. The `delta` parameter allows you to specify any desired increment including negative values. [block:code] { "codes": [ { "code": "var options = {\n\tdelta: 3,\n\tvisibility: \"App\"\n};\n\nBuddy.post('/metadata/my_id/my_key/increment',\n\t\toptions,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript" }, { "code": "NSDictionary *params = @{\n\t\t\[email protected]\"delta\": 3,\n\t\t\[email protected]\"visibility\": @\"App\"\n\t\t};\n\n[Buddy POST:@\"/metadata/my_id/my_key/increment\" parameters:params class:[BPMetadataItem class] callback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Map<String, Object> parameters = new HashMap<String, Object>();\nparameters.put(\"delta\", 3);\nparameters.put(\"visibility\", \"App\");\n\nBuddy.<MetadataItem>post(\"/metadata/my_id/my_key/increment\", parameters, new BuddyCallback<MetadataItem>(MetadataItem.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<MetadataItem> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\tdelta = 3,\n\t\t\tvisibility = \"App\"\n\t\t};\n\nvar result = await Buddy.PostAsync<MetadataItem>(\"/metadata/my_id/my_key/increment\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Path Parameters These parameters should be specified as part of the HTTP path. [block:parameters] { "data": { "0-0": "id", "0-1": "The ID of the Buddy object or application containing the target metadata.", "0-2": "buddyId", "1-0": "key", "1-1": "The key of the metadata value to increment.", "1-2": "string", "0-3": "Required", "1-3": "Required" }, "cols": 4, "rows": 2 } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "delta", "1-0": "visibility", "0-1": "Any positive or negative integer to modify the metadata value by. Defaults to 1.", "1-1": "Specifies the visibility of this item. Values are User, which means only the user that created the value can access or modify it, or App, which allows any app code to view the value.", "0-2": "number", "1-2": "string", "0-3": "Optional", "1-3": "Optional" }, "cols": 4, "rows": 2 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"key\": \"likes\",\n \"value\": 1,\n \"created\": \"/Date(1393548751000)/\",\n \"lastModified\": \"/Date(1393548685057)/\"\n },\n \"request_id\": \"4cd28867-c25d-4236-8bc4-02d31a16f567\",\n \"success\": true\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]