{"_id":"56ad35503fc1020d009776e1","githubsync":"","parentDoc":null,"category":{"_id":"56ad20660ab3c00d00ce3347","__v":11,"pages":["56ad21651c09150d00a183a0","56ad235c693f0a0d0085f0c3","56ad24afd21f1b0d00fd2f86","56ad2e5b1c09150d00a183a6","56ad305879011b0d00c32aaa","56ad30c81a7ee417009ced18","56ad31432a7860170013f711","56ad33b21a7ee417009ced1a","56ad34a0b9ac5517006b6962","56ad35503fc1020d009776e1","56e7266bdbc36117006a41ff"],"project":"56acd71213ac890d001c3c7a","version":"56acd71213ac890d001c3c7d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-30T20:43:18.400Z","from_sync":false,"order":9,"slug":"singularity-real-time-events","title":"Singularity: Real-Time Events"},"user":"56acd6caa040860d00ac94a2","version":{"_id":"56acd71213ac890d001c3c7d","project":"56acd71213ac890d001c3c7a","__v":15,"createdAt":"2016-01-30T15:30:26.928Z","releaseDate":"2016-01-30T15:30:26.928Z","categories":["56acd71313ac890d001c3c7e","56acd8f113ac890d001c3c81","56acd8f95ac4060d0027865e","56acd93a13ac890d001c3c82","56ad20660ab3c00d00ce3347","56ad356a2a7860170013f714","56ad47eb0ab3c00d00ce334f","56afd523bc304a0d00ace1df","56b29a019621f20d00efb37e","56b657e11bc6970d009feee7","5845cc3c39950c1b002afe77","5845cde163c11b250037967e","5846efd45d064323007b17b4","588604da4674e32300efd160","588627882393d50f00f1322c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"project":"56acd71213ac890d001c3c7a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-30T22:12:32.105Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Tier Modification is Complex\",\n  \"body\": \"Since GameWisp channels can modify all tiers simultaneously, it is difficult to only return particular changes for one particular tier. Therefore, this event's response will always contain information about each tier a channel has. \\n\\nIt is up to the application to determine the particular changes that caused the event to fire.\"\n}\n[/block]\nUsing Socket.IO this benefit can be listened to as follows:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"socket.on('tier-modified', function(data){\\n    //Do stuff.\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis event fires whenever a channel modifies their tiers. Due to the complexity of tier creation and editing (e.g., modifying one tier can potentially have an impact on others), the full list of tiers the channel has is returned in the tier-modified response. Depending on the number of tiers and benefits a channel has available, this response can be quite large.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   event: \\\"tier-modified\\\",\\n   channel_id: \\\"channel identifier\\\",\\n   channel: {\\n      names: {\\n         gamewisp: \\\"GameWisp channel name\\\",\\n         twitch: \\\"twitch channel name\\\",\\n         youtube: \\\"youtube channel name\\\"\\n      },\\n      ids: {\\n         gamewisp: \\\"channel identifier\\\",\\n         twitch: \\\"12312312q\\\",\\n         youtube: \\\"UCiqp4J8asdkssssssssdfae\\\"\\n      }  \\n   },\\n   data: [\\n      {\\n         id: \\\"12334\\\",\\n         title: \\\"Tier Title\\\",\\n         level: \\\"1\\\",\\n         cost: \\\"3.99\\\",\\n         description: \\\"Tier description.\\\",\\n         published: true,\\n         benefits: [\\n             //array of benefit objects for this tier.\\n         ]\\n         subscribers: 0\\n      },\\n      //More tiers if the channel has created them...\\n   ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Fires whenever a channel modifies one of their tiers.","slug":"tier-modified","type":"fn","title":"tier-modified"}

tier-modified

Fires whenever a channel modifies one of their tiers.

[block:callout] { "type": "warning", "title": "Tier Modification is Complex", "body": "Since GameWisp channels can modify all tiers simultaneously, it is difficult to only return particular changes for one particular tier. Therefore, this event's response will always contain information about each tier a channel has. \n\nIt is up to the application to determine the particular changes that caused the event to fire." } [/block] Using Socket.IO this benefit can be listened to as follows: [block:code] { "codes": [ { "code": "socket.on('tier-modified', function(data){\n //Do stuff.\n});", "language": "javascript" } ] } [/block] This event fires whenever a channel modifies their tiers. Due to the complexity of tier creation and editing (e.g., modifying one tier can potentially have an impact on others), the full list of tiers the channel has is returned in the tier-modified response. Depending on the number of tiers and benefits a channel has available, this response can be quite large. [block:code] { "codes": [ { "code": "{\n event: \"tier-modified\",\n channel_id: \"channel identifier\",\n channel: {\n names: {\n gamewisp: \"GameWisp channel name\",\n twitch: \"twitch channel name\",\n youtube: \"youtube channel name\"\n },\n ids: {\n gamewisp: \"channel identifier\",\n twitch: \"12312312q\",\n youtube: \"UCiqp4J8asdkssssssssdfae\"\n } \n },\n data: [\n {\n id: \"12334\",\n title: \"Tier Title\",\n level: \"1\",\n cost: \"3.99\",\n description: \"Tier description.\",\n published: true,\n benefits: [\n //array of benefit objects for this tier.\n ]\n subscribers: 0\n },\n //More tiers if the channel has created them...\n ]\n}", "language": "json" } ] } [/block]