{"_id":"566c97749aa84517001b4fca","project":"544494099be40214000dedb6","version":{"_id":"566c97729aa84517001b4fbb","__v":1,"project":"544494099be40214000dedb6","createdAt":"2015-12-12T21:53:54.721Z","releaseDate":"2015-12-12T21:53:54.721Z","categories":["566c97739aa84517001b4fbc","566c97739aa84517001b4fbd","566c97739aa84517001b4fbe","566c97739aa84517001b4fbf"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.1.0","version":"2.1"},"user":"544493a7a21e4d140055d913","__v":0,"category":{"_id":"566c97739aa84517001b4fbf","version":"566c97729aa84517001b4fbb","__v":1,"pages":["566c97749aa84517001b4fca","566c97749aa84517001b4fcb"],"project":"544494099be40214000dedb6","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-20T06:04:49.755Z","from_sync":false,"order":3,"slug":"what-is","title":"What is"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-20T06:06:18.401Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":14,"body":"A scenario is a sentence which contains an **event** that triggers an **action**. Every scenario has specific preferences that you customize.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Opi3HvCKT5ydgBgkoW8z_scenario.png\",\n        \"scenario.png\",\n        \"684\",\n        \"87\",\n        \"#d46251\",\n        \"\"\n      ],\n      \"caption\": \"This is a scenario.\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Event\"\n}\n[/block]\nEvery scenario has an **event**, colored in blue. Possible events are:\n\n  * Enters to\n \n  **e.g.** the application is closed or in the background, and the user enters the region of your beacons\n \n  * Exit from\n  \n  **e.g.** the application is closed or in the background, and the user exits from the region of your beacons\n \n  * Comes nearby to\n  \n  The application is in the foreground, and the user is walking in the the region of your beacons\n[block:html]\n{\n  \"html\": \"<table align=\\\"center\\\" border=\\\"0\\\" cellpadding=\\\"5\\\" cellspacing=\\\"1\\\" style=\\\"width: 100%;\\\">\\n<thead>\\n<tr>\\n<th scope=\\\"row\\\">\\n\\t\\t\\t\\t<a id=\\\"event-preferences\\\" name=\\\"event-preferences\\\"></a>\\n\\t\\t\\t</th>\\n<th scope=\\\"col\\\" style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\t<strong>Triggers on</strong>\\n\\t\\t\\t</th>\\n<th scope=\\\"col\\\" style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\t<strong>Proximity Setting</strong>\\n\\t\\t\\t</th>\\n<th scope=\\\"col\\\" style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\t<strong>Notification Sending</strong>\\n\\t\\t\\t</th>\\n</tr>\\n</thead>\\n<caption>\\n\\t\\tEvents preferences table<br>\\n\\t</caption>\\n<tbody>\\n<tr>\\n<th scope=\\\"row\\\" style=\\\"text-align: left;\\\">\\n\\t\\t\\t\\t<strong>Enters to</strong>\\n\\t\\t\\t</th>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tBackground, Foreground\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tNo\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tYes\\n\\t\\t\\t</td>\\n</tr>\\n<tr>\\n<th scope=\\\"row\\\" style=\\\"text-align: left;\\\">\\n\\t\\t\\t\\t<strong>Exit from</strong>\\n\\t\\t\\t</th>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tBackground, Foreground\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tNo\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tYes\\n\\t\\t\\t</td>\\n</tr>\\n<tr>\\n<th scope=\\\"row\\\" style=\\\"text-align: left;\\\">\\n\\t\\t\\t\\t<strong>Comes nearby to</strong>\\n\\t\\t\\t</th>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tForeground\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tYes\\n\\t\\t\\t</td>\\n<td style=\\\"text-align: center;\\\">\\n\\t\\t\\t\\tNo\\n\\t\\t\\t</td>\\n</tr>\\n</tbody>\\n</table>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Action\"\n}\n[/block]\nEvery scenario has an **action**, colored in red. Possible actions are:\n\n  * Show Image\n  * Show Video\n  * Show HTML\n  * Open URL\n  * Show Coupon Template\n  * Show Survey \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/jc9s6SNQtCJ8FOjVQVEm_actions.png\",\n        \"actions.png\",\n        \"266\",\n        \"268\",\n        \"\",\n        \"\"\n      ],\n      \"caption\": \"Available actions list.\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Preferences\"\n}\n[/block]\nEvery scenario has it's own preferences. You can toggle scenario preferences by clicking the wrench icon on or left of the scenario.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/PpffTEamTw6FYxD9uKIN_scenario-preferences.png\",\n        \"scenario-preferences.png\",\n        \"912\",\n        \"456\",\n        \"#ae5740\",\n        \"\"\n      ],\n      \"caption\": \"Preferences of a scenario.\"\n    }\n  ]\n}\n[/block]\nAvailable preferences are:\n\n* **Action Details**\n\n  Show the selected action's detail settings.\n\n  **e.g.** If you chose \"show video\", you will see video upload section here.\n \n\n* **Proximity Settings** (This setting is only enabled if you chose the \"comes nearby to\" event)\n\n  Setting for \"Which proximity zone will trigger your action?\" question. Far, Near and Immediate are available proximity options.\n\n  **e.g.** you are creating scenarios for a museum and want to show different images of an art object in different proximity zones.\n \n\n* **Threshold Settings**\n\n  When do you want to retrigger this action again?\n\n  **e.g.** a user came close to you beacon and saw a coupon. When will he/she see that coupon again?\n \n\n* **Delete Scenario**\n\n  Use this to delete a scenario from the scenarioboard.","excerpt":"","slug":"scenario","type":"basic","title":"Scenario"}
A scenario is a sentence which contains an **event** that triggers an **action**. Every scenario has specific preferences that you customize. [block:image] { "images": [ { "image": [ "https://files.readme.io/Opi3HvCKT5ydgBgkoW8z_scenario.png", "scenario.png", "684", "87", "#d46251", "" ], "caption": "This is a scenario." } ] } [/block] [block:api-header] { "type": "basic", "title": "Event" } [/block] Every scenario has an **event**, colored in blue. Possible events are: * Enters to **e.g.** the application is closed or in the background, and the user enters the region of your beacons * Exit from **e.g.** the application is closed or in the background, and the user exits from the region of your beacons * Comes nearby to The application is in the foreground, and the user is walking in the the region of your beacons [block:html] { "html": "<table align=\"center\" border=\"0\" cellpadding=\"5\" cellspacing=\"1\" style=\"width: 100%;\">\n<thead>\n<tr>\n<th scope=\"row\">\n\t\t\t\t<a id=\"event-preferences\" name=\"event-preferences\"></a>\n\t\t\t</th>\n<th scope=\"col\" style=\"text-align: center;\">\n\t\t\t\t<strong>Triggers on</strong>\n\t\t\t</th>\n<th scope=\"col\" style=\"text-align: center;\">\n\t\t\t\t<strong>Proximity Setting</strong>\n\t\t\t</th>\n<th scope=\"col\" style=\"text-align: center;\">\n\t\t\t\t<strong>Notification Sending</strong>\n\t\t\t</th>\n</tr>\n</thead>\n<caption>\n\t\tEvents preferences table<br>\n\t</caption>\n<tbody>\n<tr>\n<th scope=\"row\" style=\"text-align: left;\">\n\t\t\t\t<strong>Enters to</strong>\n\t\t\t</th>\n<td style=\"text-align: center;\">\n\t\t\t\tBackground, Foreground\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tNo\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tYes\n\t\t\t</td>\n</tr>\n<tr>\n<th scope=\"row\" style=\"text-align: left;\">\n\t\t\t\t<strong>Exit from</strong>\n\t\t\t</th>\n<td style=\"text-align: center;\">\n\t\t\t\tBackground, Foreground\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tNo\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tYes\n\t\t\t</td>\n</tr>\n<tr>\n<th scope=\"row\" style=\"text-align: left;\">\n\t\t\t\t<strong>Comes nearby to</strong>\n\t\t\t</th>\n<td style=\"text-align: center;\">\n\t\t\t\tForeground\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tYes\n\t\t\t</td>\n<td style=\"text-align: center;\">\n\t\t\t\tNo\n\t\t\t</td>\n</tr>\n</tbody>\n</table>" } [/block] [block:api-header] { "type": "basic", "title": "Action" } [/block] Every scenario has an **action**, colored in red. Possible actions are: * Show Image * Show Video * Show HTML * Open URL * Show Coupon Template * Show Survey [block:image] { "images": [ { "image": [ "https://files.readme.io/jc9s6SNQtCJ8FOjVQVEm_actions.png", "actions.png", "266", "268", "", "" ], "caption": "Available actions list." } ] } [/block] [block:api-header] { "type": "basic", "title": "Preferences" } [/block] Every scenario has it's own preferences. You can toggle scenario preferences by clicking the wrench icon on or left of the scenario. [block:image] { "images": [ { "image": [ "https://files.readme.io/PpffTEamTw6FYxD9uKIN_scenario-preferences.png", "scenario-preferences.png", "912", "456", "#ae5740", "" ], "caption": "Preferences of a scenario." } ] } [/block] Available preferences are: * **Action Details** Show the selected action's detail settings. **e.g.** If you chose "show video", you will see video upload section here. * **Proximity Settings** (This setting is only enabled if you chose the "comes nearby to" event) Setting for "Which proximity zone will trigger your action?" question. Far, Near and Immediate are available proximity options. **e.g.** you are creating scenarios for a museum and want to show different images of an art object in different proximity zones. * **Threshold Settings** When do you want to retrigger this action again? **e.g.** a user came close to you beacon and saw a coupon. When will he/she see that coupon again? * **Delete Scenario** Use this to delete a scenario from the scenarioboard.