{"_id":"56c41d684040602b0064ceaa","githubsync":"","__v":5,"category":{"_id":"56c4184754b6030d00ec29a1","__v":5,"version":"56bc8e689afb8b0d00d62dd2","pages":["56c41d423d30210d00ea851d","56c41d4954b6030d00ec29ae","56c41d602e75e0170098605c","56c41d684040602b0064ceaa","56c41d6f106c12170020dba8"],"project":"56bc8e679afb8b0d00d62dcf","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:47.963Z","from_sync":false,"order":5,"slug":"messages","title":"Messages"},"parentDoc":null,"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"},"project":"56bc8e679afb8b0d00d62dcf","user":"56b98db7bb36440d0001f492","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T07:12:40.689Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/messages\"\n}\n[/block]\nSearches for messages matching the given criteria.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\ttype: \\\"Sent\\\",\\n\\tthread: \\\"Thread Title\\\",\\n\\tlocationRange: \\\"47.1, -122.3, 10000\\\",\\n\\tcreated: \\\"2014/6/01-2014/12/31\\\",\\n\\tlastModified: \\\"2014/6/01-2014/12/31\\\",\\n\\tsortOrder: \\\"-{sortingParameter}\\\",\\n\\tpagingToken: \\\"10;20\\\",\\n\\tisNew: false,\\n\\tsent: \\\"1405454736867\\\",\\n\\ttag: \\\"Some useful tag\\\",\\n\\townerID: \\\"bvc.nqgbvzkcrDlr\\\"\\n};\\n\\nBuddy.get('/messages',\\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]\\\"type\\\": @\\\"Sent\\\",\\n\\t\\t\\[email protected]\\\"thread\\\": @\\\"Thread Title\\\",\\n\\t\\t\\[email protected]\\\"locationRange\\\": BPCoordinateRangeMake(47.1, -121.292, 2500),\\n\\t\\t\\[email protected]\\\"created\\\": @\\\"2014/6/01-2014/12/31\\\",\\n\\t\\t\\[email protected]\\\"lastModified\\\": @\\\"2014/6/01-2014/12/31\\\",\\n\\t\\t\\[email protected]\\\"sortOrder\\\": @\\\"-{sortingParameter}\\\",\\n\\t\\t\\[email protected]\\\"pagingToken\\\": @\\\"10;20\\\",\\n\\t\\t\\[email protected]\\\"isNew\\\": false,\\n\\t\\t\\[email protected]\\\"sent\\\": @\\\"1405454736867\\\",\\n\\t\\t\\[email protected]\\\"tag\\\": @\\\"Some useful tag\\\",\\n\\t\\t\\[email protected]\\\"ownerID\\\": @\\\"bvc.nqgbvzkcrDlr\\\"\\n\\t\\t};\\n\\n[Buddy GET:@\\\"/messages\\\" parameters:params class:[BPPagedResult 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(\\\"type\\\", \\\"Sent\\\");\\nparameters.put(\\\"thread\\\", \\\"Thread Title\\\");\\nparameters.put(\\\"locationRange\\\", myLocationRange);\\nparameters.put(\\\"created\\\", \\\"2014/6/01-2014/12/31\\\");\\nparameters.put(\\\"lastModified\\\", \\\"2014/6/01-2014/12/31\\\");\\nparameters.put(\\\"sortOrder\\\", \\\"-{sortingParameter}\\\");\\nparameters.put(\\\"pagingToken\\\", \\\"10;20\\\");\\nparameters.put(\\\"isNew\\\", false);\\nparameters.put(\\\"sent\\\", \\\"1405454736867\\\");\\nparameters.put(\\\"tag\\\", \\\"Some useful tag\\\");\\nparameters.put(\\\"ownerID\\\", \\\"bvc.nqgbvzkcrDlr\\\");\\n\\nBuddy.get(\\\"/messages\\\", parameters, new BuddyCallback<PagedResult>(PagedResult.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<PagedResult> result) {\\n\\t\\tList<Message> resultList = result.getResult().convertPageResults(Message.class);\\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\\ttype = \\\"Sent\\\",\\n\\t\\t\\tthread = \\\"Thread Title\\\",\\n\\t\\t\\tlocationRange = new BuddyGeoLocationRange(47.1, -122.3, 5000),\\n\\t\\t\\tcreated = \\\"2014/6/01-2014/12/31\\\",\\n\\t\\t\\tlastModified = \\\"2014/6/01-2014/12/31\\\",\\n\\t\\t\\tsortOrder = \\\"-{sortingParameter}\\\",\\n\\t\\t\\tpagingToken = \\\"10;20\\\",\\n\\t\\t\\tisNew = false,\\n\\t\\t\\tsent = \\\"1405454736867\\\",\\n\\t\\t\\ttag = \\\"Some useful tag\\\",\\n\\t\\t\\townerID = \\\"bvc.nqgbvzkcrDlr\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.GetAsync<PagedResult<Message>>(\\\"/messages\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\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\": \"type\",\n    \"1-0\": \"thread\",\n    \"2-0\": \"locationRange\",\n    \"3-0\": \"created\",\n    \"4-0\": \"lastModified\",\n    \"5-0\": \"sortOrder\",\n    \"6-0\": \"pagingToken\",\n    \"7-0\": \"isNew\",\n    \"8-0\": \"sent\",\n    \"9-0\": \"tag\",\n    \"10-0\": \"ownerID\",\n    \"0-1\": \"The message state, either \\\"Sent\\\" or \\\"Received\\\".\",\n    \"1-1\": \"Searches for messages belonging to a continuous message series.\",\n    \"2-1\": \"Specifies the location and range to search within specified as {latitude}, {longitude}, {range in meters}, for example 47.1,-122.3,10000. Note: there is a maximum searchable radius of 20,000 meters.\",\n    \"3-1\": \"Searches for the created value of an object by date range. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970) such as \\\"136512000000-1398816000000\\\" and common date formats such as \\\"2012/1/27-2014/5/6\\\"\",\n    \"4-1\": \"Searches for the lastModified value of an object by date range. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970) such as \\\"136512000000-1398816000000\\\" and common date formats such as \\\"2012/1/27-2014/5/6\\\".\",\n    \"5-1\": \"Specifies the order in which a collection of results should be returned. To use this parameter, identify the parameter to sort on and prepend it with \\\"+\\\" to sort the results on field in ascending order or \\\"-\\\" for descending order (e.g. specifying \\\"+firstName\\\" will sort the results on the first name of each record, in ascending order).\",\n    \"6-1\": \"Specifies the current page of results to obtain in a multi-page result set. The token can be obtained from a search result set by looking at the currentToken, nextToken, and previousToken result values which, when used in a subsequent search, will return the current, next, and previous page of results. Paging can be specified manually in the format \\\"{limit};{skip}\\\", where \\\"10;20\\\" would dictate a \\\"page limit of 10, skipping the first 20 results.\\\"\",\n    \"7-1\": \"Searches for read/unread messages.\",\n    \"8-1\": \"A Unix timestamp representing when the message was sent.\",\n    \"9-1\": \"A string value to attach to this object. This value will be returned with the object as a property called tag.\",\n    \"10-1\": \"The Buddy ID of the user who owns (created) this object.\",\n    \"10-2\": \"buddyId\",\n    \"9-2\": \"string\",\n    \"8-2\": \"string\",\n    \"7-2\": \"bool\",\n    \"6-2\": \"string\",\n    \"5-2\": \"string\",\n    \"4-2\": \"string\",\n    \"3-2\": \"string\",\n    \"2-2\": \"string\",\n    \"1-2\": \"string\",\n    \"0-2\": \"string\",\n    \"0-3\": \"Optional\",\n    \"1-3\": \"Optional\",\n    \"2-3\": \"Optional\",\n    \"3-3\": \"Optional\",\n    \"4-3\": \"Optional\",\n    \"5-3\": \"Optional\",\n    \"6-3\": \"Optional\",\n    \"7-3\": \"Optional\",\n    \"8-3\": \"Optional\",\n    \"9-3\": \"Optional\",\n    \"10-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 200,\\n  \\\"result\\\": {\\n    \\\"currentToken\\\": \\\"W3siQXBwSUQiOiJiYmJiYmMuRGRoYnZmTGhLZ0RuIiwiT2JqZWN0VHlwZU5hbWUiOiJNZXNzYWdlIiwiUGFyZW50T2JqZWN0SUQiOm51bGwsIlJlcXVlc3RpbmdVc2VySUQiOiJidi5rQ2hidnNoZEhuRG4iLCJPd25lclVzZXJJRCI6bnVsbCwiTG9jYXRpb24iOm51bGwsIlNlYXJjaERpc3RhbmNlSW5NZXRlcnMiOjAsIlNlYXJjaFByb3BlcnRpZXMiOltdLCJQcm9wZXJ0eVNvcnQiOltdLCJNYXhSZXN1bHRzIjoxMDAsIlNraXAiOjAsIlBlcm1pc3Npb25zVG9Vc2UiOjN9LCIxMDA7MCIsIjIwMTQtMDctMTVUMjA6MjA6MjIuNzciXQ2\\\",\\n    \\\"pageResults\\\": [\\n      {\\n        \\\"subject\\\": \\\"Test Message\\\",\\n        \\\"type\\\": \\\"Sent\\\",\\n        \\\"recipients\\\": [\\n          \\\"bv.kChbvshdHnDn\\\"\\n        ],\\n        \\\"isNew\\\": true,\\n        \\\"sent\\\": \\\"/Date(1405454736867)/\\\",\\n        \\\"thread\\\": \\\"b014a556-ed94-47ea-98d8-b5f8c43ffd12\\\",\\n        \\\"from\\\": \\\"bv.kChbvshdHnDn\\\",\\n        \\\"fromName\\\": \\\"\\\",\\n        \\\"toName\\\": \\\"\\\",\\n        \\\"to\\\": \\\"bv.kChbvshdHnDn\\\",\\n        \\\"id\\\": \\\"gb.FHhbbzkMvxxp\\\",\\n        \\\"created\\\": \\\"/Date(1405454736867)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1405455330750)/\\\"\\n      },\\n      {\\n        \\\"subject\\\": \\\"Test Message\\\",\\n        \\\"type\\\": \\\"Received\\\",\\n        \\\"recipients\\\": [\\n          \\\"bv.kChbvshdHnDn\\\"\\n        ],\\n        \\\"isNew\\\": true,\\n        \\\"sent\\\": \\\"/Date(1405454736783)/\\\",\\n        \\\"thread\\\": \\\"b014a556-ed94-47ea-98d8-b5f8c43ffd12\\\",\\n        \\\"from\\\": \\\"bv.kChbvshdHnDn\\\",\\n        \\\"fromName\\\": \\\"\\\",\\n        \\\"toName\\\": \\\"\\\",\\n        \\\"to\\\": \\\"bv.kChbvshdHnDn\\\",\\n        \\\"id\\\": \\\"gb.DHhbvmjMvxxp\\\",\\n        \\\"created\\\": \\\"/Date(1405454736783)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1405454736783)/\\\"\\n      }\\n    ]\\n  },\\n  \\\"request_id\\\": \\\"53c58d07b32fad0f9c61bc85\\\",\\n  \\\"success\\\": true\\n} \",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"search-messages","type":"basic","title":"Search Messages"}
[block:api-header] { "type": "get", "title": "/messages" } [/block] Searches for messages matching the given criteria. [block:code] { "codes": [ { "code": "var options = {\n\ttype: \"Sent\",\n\tthread: \"Thread Title\",\n\tlocationRange: \"47.1, -122.3, 10000\",\n\tcreated: \"2014/6/01-2014/12/31\",\n\tlastModified: \"2014/6/01-2014/12/31\",\n\tsortOrder: \"-{sortingParameter}\",\n\tpagingToken: \"10;20\",\n\tisNew: false,\n\tsent: \"1405454736867\",\n\ttag: \"Some useful tag\",\n\townerID: \"bvc.nqgbvzkcrDlr\"\n};\n\nBuddy.get('/messages',\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]\"type\": @\"Sent\",\n\t\t\[email protected]\"thread\": @\"Thread Title\",\n\t\t\[email protected]\"locationRange\": BPCoordinateRangeMake(47.1, -121.292, 2500),\n\t\t\[email protected]\"created\": @\"2014/6/01-2014/12/31\",\n\t\t\[email protected]\"lastModified\": @\"2014/6/01-2014/12/31\",\n\t\t\[email protected]\"sortOrder\": @\"-{sortingParameter}\",\n\t\t\[email protected]\"pagingToken\": @\"10;20\",\n\t\t\[email protected]\"isNew\": false,\n\t\t\[email protected]\"sent\": @\"1405454736867\",\n\t\t\[email protected]\"tag\": @\"Some useful tag\",\n\t\t\[email protected]\"ownerID\": @\"bvc.nqgbvzkcrDlr\"\n\t\t};\n\n[Buddy GET:@\"/messages\" parameters:params class:[BPPagedResult 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(\"type\", \"Sent\");\nparameters.put(\"thread\", \"Thread Title\");\nparameters.put(\"locationRange\", myLocationRange);\nparameters.put(\"created\", \"2014/6/01-2014/12/31\");\nparameters.put(\"lastModified\", \"2014/6/01-2014/12/31\");\nparameters.put(\"sortOrder\", \"-{sortingParameter}\");\nparameters.put(\"pagingToken\", \"10;20\");\nparameters.put(\"isNew\", false);\nparameters.put(\"sent\", \"1405454736867\");\nparameters.put(\"tag\", \"Some useful tag\");\nparameters.put(\"ownerID\", \"bvc.nqgbvzkcrDlr\");\n\nBuddy.get(\"/messages\", parameters, new BuddyCallback<PagedResult>(PagedResult.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<PagedResult> result) {\n\t\tList<Message> resultList = result.getResult().convertPageResults(Message.class);\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\ttype = \"Sent\",\n\t\t\tthread = \"Thread Title\",\n\t\t\tlocationRange = new BuddyGeoLocationRange(47.1, -122.3, 5000),\n\t\t\tcreated = \"2014/6/01-2014/12/31\",\n\t\t\tlastModified = \"2014/6/01-2014/12/31\",\n\t\t\tsortOrder = \"-{sortingParameter}\",\n\t\t\tpagingToken = \"10;20\",\n\t\t\tisNew = false,\n\t\t\tsent = \"1405454736867\",\n\t\t\ttag = \"Some useful tag\",\n\t\t\townerID = \"bvc.nqgbvzkcrDlr\"\n\t\t};\n\nvar result = await Buddy.GetAsync<PagedResult<Message>>(\"/messages\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "type", "1-0": "thread", "2-0": "locationRange", "3-0": "created", "4-0": "lastModified", "5-0": "sortOrder", "6-0": "pagingToken", "7-0": "isNew", "8-0": "sent", "9-0": "tag", "10-0": "ownerID", "0-1": "The message state, either \"Sent\" or \"Received\".", "1-1": "Searches for messages belonging to a continuous message series.", "2-1": "Specifies the location and range to search within specified as {latitude}, {longitude}, {range in meters}, for example 47.1,-122.3,10000. Note: there is a maximum searchable radius of 20,000 meters.", "3-1": "Searches for the created value of an object by date range. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970) such as \"136512000000-1398816000000\" and common date formats such as \"2012/1/27-2014/5/6\"", "4-1": "Searches for the lastModified value of an object by date range. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970) such as \"136512000000-1398816000000\" and common date formats such as \"2012/1/27-2014/5/6\".", "5-1": "Specifies the order in which a collection of results should be returned. To use this parameter, identify the parameter to sort on and prepend it with \"+\" to sort the results on field in ascending order or \"-\" for descending order (e.g. specifying \"+firstName\" will sort the results on the first name of each record, in ascending order).", "6-1": "Specifies the current page of results to obtain in a multi-page result set. The token can be obtained from a search result set by looking at the currentToken, nextToken, and previousToken result values which, when used in a subsequent search, will return the current, next, and previous page of results. Paging can be specified manually in the format \"{limit};{skip}\", where \"10;20\" would dictate a \"page limit of 10, skipping the first 20 results.\"", "7-1": "Searches for read/unread messages.", "8-1": "A Unix timestamp representing when the message was sent.", "9-1": "A string value to attach to this object. This value will be returned with the object as a property called tag.", "10-1": "The Buddy ID of the user who owns (created) this object.", "10-2": "buddyId", "9-2": "string", "8-2": "string", "7-2": "bool", "6-2": "string", "5-2": "string", "4-2": "string", "3-2": "string", "2-2": "string", "1-2": "string", "0-2": "string", "0-3": "Optional", "1-3": "Optional", "2-3": "Optional", "3-3": "Optional", "4-3": "Optional", "5-3": "Optional", "6-3": "Optional", "7-3": "Optional", "8-3": "Optional", "9-3": "Optional", "10-3": "Optional" }, "cols": 4, "rows": 11 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"currentToken\": \"W3siQXBwSUQiOiJiYmJiYmMuRGRoYnZmTGhLZ0RuIiwiT2JqZWN0VHlwZU5hbWUiOiJNZXNzYWdlIiwiUGFyZW50T2JqZWN0SUQiOm51bGwsIlJlcXVlc3RpbmdVc2VySUQiOiJidi5rQ2hidnNoZEhuRG4iLCJPd25lclVzZXJJRCI6bnVsbCwiTG9jYXRpb24iOm51bGwsIlNlYXJjaERpc3RhbmNlSW5NZXRlcnMiOjAsIlNlYXJjaFByb3BlcnRpZXMiOltdLCJQcm9wZXJ0eVNvcnQiOltdLCJNYXhSZXN1bHRzIjoxMDAsIlNraXAiOjAsIlBlcm1pc3Npb25zVG9Vc2UiOjN9LCIxMDA7MCIsIjIwMTQtMDctMTVUMjA6MjA6MjIuNzciXQ2\",\n \"pageResults\": [\n {\n \"subject\": \"Test Message\",\n \"type\": \"Sent\",\n \"recipients\": [\n \"bv.kChbvshdHnDn\"\n ],\n \"isNew\": true,\n \"sent\": \"/Date(1405454736867)/\",\n \"thread\": \"b014a556-ed94-47ea-98d8-b5f8c43ffd12\",\n \"from\": \"bv.kChbvshdHnDn\",\n \"fromName\": \"\",\n \"toName\": \"\",\n \"to\": \"bv.kChbvshdHnDn\",\n \"id\": \"gb.FHhbbzkMvxxp\",\n \"created\": \"/Date(1405454736867)/\",\n \"lastModified\": \"/Date(1405455330750)/\"\n },\n {\n \"subject\": \"Test Message\",\n \"type\": \"Received\",\n \"recipients\": [\n \"bv.kChbvshdHnDn\"\n ],\n \"isNew\": true,\n \"sent\": \"/Date(1405454736783)/\",\n \"thread\": \"b014a556-ed94-47ea-98d8-b5f8c43ffd12\",\n \"from\": \"bv.kChbvshdHnDn\",\n \"fromName\": \"\",\n \"toName\": \"\",\n \"to\": \"bv.kChbvshdHnDn\",\n \"id\": \"gb.DHhbvmjMvxxp\",\n \"created\": \"/Date(1405454736783)/\",\n \"lastModified\": \"/Date(1405454736783)/\"\n }\n ]\n },\n \"request_id\": \"53c58d07b32fad0f9c61bc85\",\n \"success\": true\n} ", "language": "json", "name": "Response" } ], "sidebar": true } [/block]