{"id":4309,"date":"2021-11-16T18:13:53","date_gmt":"2021-11-16T10:13:53","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4309"},"modified":"2022-05-30T21:29:35","modified_gmt":"2022-05-30T13:29:35","slug":"room-entry-restriction","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/android-toolkit\/room-entry-restriction\/","title":{"rendered":"Room Entry Restriction: Android SDK &#8211; Video API"},"content":{"rendered":"\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#lock-unlock-room\">Lock \/ Unlock Room<\/a><\/li><li><a href=\"#allow-deny-room-entry\">Moderate Participant Entry to Session<\/a><\/li><\/ul>\n\n\n\n<a name=\"lock-unlock-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Lock \/ Unlock Room<\/h2>\n\n\n\n<p>The&nbsp;<code>EnxRoom.lockRoom()<\/code>&nbsp;method allows the Moderator to lock the Room which forbids any new user from joining the Session. The Moderator can unlock the Room using <code>EnxRoom.unLockRoom()&nbsp;<\/code>method to allow subsequent users to join the Session.<\/p>\n\n\n\n<p><strong>Class<\/strong>:&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Methods:<\/strong><\/p>\n\n\n\n<ul><li> <code>public void lockRoom()<\/code> \u2013 No Parameter required.<\/li><li> <code>public void unLockRoom()<\/code> \u2013 No Parameter required.<\/li><\/ul>\n\n\n\n<p><strong>Callbacks:<\/strong><\/p>\n\n\n\n<ul><li><code>onAckLockRoom -<\/code> Acknowledgment to the Moderator when the Room is locked.<\/li><li><code>onLockedRoom -<\/code>&nbsp;Notification to all the participants in the Room when the room is locked.<\/li><li><code>onAckUnLockRoom -<\/code>&nbsp;Acknowledgment to the Moderator when the Room is unlocked.<\/li><li><code>onUnLockedRoom -<\/code>&nbsp;Notification to all the participants in the Room when the room is unlocked.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">room.lockRoom();\n\n\/\/ Moderator is acknowledged that room has been locked \npublic void onAckLockRoom(JSONObject jsonObject) {\n\t\/\/ Handle JSONObject\n}\n\n\/\/ Participants are notified that room has been locked\npublic void onLockedRoom(JSONObject jsonObject) {\n\t\/\/ Handle JSONObject\n}\n\nroom.unLockRoom();\n\n\/\/ Moderator is acknowledged that room has been unlocked \npublic void onAckUnLockRoom(JSONObject jsonObject) {\n\t\/\/ Handle JSONObject\n}\n\n\/\/ Participants are notified that room has been unlocked\npublic void onUnLockedRoom(JSONObject jsonObject) {\n\t\/\/ Handle JSONObject\n}\n<\/pre>\n\n\n\n<p><strong>Error Codes &amp; Exceptions<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5115<\/td><td>Unauthorized Access. When a user with <code>participant<\/code> role invokes <code>lockRoom()<\/code> or un<code>lockRoom()<\/code>.<\/td><\/tr><tr><td>5117<\/td><td>Invalid request. When the Moderator invokes <code>lockRoom()<\/code> on a locked Room. <\/td><\/tr><tr><td>5118<\/td><td>Invalid request. When the Moderator invokes <code>un<code>lockRoom()<\/code><\/code> on an unlocked Room.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<a name=\"allow-deny-room-entry\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Moderate Participant&#8217;s entry to a Session<\/h2>\n\n\n\n<p>In a&nbsp;<a href=\"..\/..\/..\/server-api\/rooms-route\/#create-room\" target=\"_blank\" rel=\"noreferrer noopener\">knock-enabled Room,<\/a>&nbsp;a user needs to wait until the Moderator grants them permission to join the Session. The&nbsp;<code>EnxRoom.approveAwaitedUser()<\/code>&nbsp;method allows the Moderator to approve a user\u2019s entry and&nbsp;<code>EnxRoom.denyAwaitedUser()<\/code>&nbsp;method is used to decline a user\u2019s entry to the Session.<\/p>\n\n\n\n<p><strong>Methods: <\/strong><\/p>\n\n\n\n<ul><li><code><code>public void approveAwaitedUser(String clientId)<\/code> <\/code><\/li><li><code><code>public void denyAwaitedUser(String clientId)<\/code> <\/code><\/li><\/ul>\n\n\n\n<p><strong>Callbacks:<\/strong><\/p>\n\n\n\n<ul><li><code>onUserAwaited<\/code> &#8211; Notification to the Moderator when a user awaits their permission to join Room.<\/li><li><code>onRoomAwaited<\/code> &#8211; Notification to the user when they await Moderator&#8217;s permission to join Room with { &#8220;event_type&#8221;: &#8220;knock&#8221; } in the JSON Payload.<\/li><li><code>onAckForApproveAwaitedUser <\/code>&#8211; Acknowledgment to the Moderator when the user is granted permission to join Room.<\/li><li><code>onRoomConnected<\/code> &#8211; Notification to the user when the user is permitted to join Room.<\/li><li> <code>onAckForDenyAwaitedUser <\/code>&#8211; Acknowledgment to the Moderator when the user is denied permission to join Room. <\/li><li><code>onRoomDisconnected<\/code> &#8211; Notification to the user along with a reason for denial when the user is denied access to the Room. <\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ Moderator is notified about awaited user\npublic void onUserAwaited(JSONObject jsonObject)  {\n\t\/\/ Awaited Client Info in the jsonObject, e.g.\n\t\/\/ {\"id\",\"String\", \"name\": \"String\u201d} \n\t\n\tenxRoom.approveAwaitedUser(jsonObject.id);  \/\/ To allow user to join room\n\n\tenxRoom.denyAwaitedUser(jsonObject.id); \/\/ To deny user \n\t \n};\n\npublic void onAckForApproveAwaitedUser(JSONObject jsonObject) {\n\t\/\/ User has been allowed entry\t\n}\n\npublic void onAckForDenyAwaitedUser(JSONObject jsonObject) {\n\t\/\/ User has been denied entry\t\n}<\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>To manage awaited users when moderator joins late<\/h4>\n\n\n\n<p>If the Moderator joins after the participant(s) have sent a request to join the Session in a Knock-enabled Room, then the Moderator can get the list of participants awaiting approval using&nbsp;<code>room.awaitedParticipants<\/code>. You can utilize this attribute to build UI for Moderator controls to handle pending approvals.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ e.g. room.awaitedParticipants\n\n[\n\t{\t\"clientId\u201d: \"String\", \n\t\t\"name\": \"String\" \n\t}\n]\n<\/pre>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<hr class=\"wp-block-separator is-style-wide\"\/>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<p>\u2190 <a href=\"..\/how-to-use\/\"> <\/a><a href=\"\/developer\/video-api\/client-api\/web-toolkit\/hard-muting\/\">Hard Muting<\/a> <\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-center\"><a href=\"..\/\">Index<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-right\"><a href=\"..\/disconnect-user\/\">Disconnect User<\/a> \u2192<a href=\"\/developer\/how-to-use\/\"><\/a><\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Table of Contents Lock \/ Unlock Room Moderate Participant Entry to Session Lock \/ Unlock Room The&nbsp;EnxRoom.lockRoom()&nbsp;method allows the Moderator to lock the Room which forbids any new user from joining the Session. The Moderator can unlock the Room using EnxRoom.unLockRoom()&nbsp;method to allow subsequent users to join the Session. Class:&nbsp;EnxRoom Methods: public void lockRoom() \u2013 No Parameter required. public void unLockRoom() \u2013 No Parameter required. Callbacks: onAckLockRoom &#8211; Acknowledgment to&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3740,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ub_ctt_via":""},"featured_image_src":null,"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"featured":false,"featured-large":false},"uagb_author_info":{"display_name":"vcxdevwpadmin","author_link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/author\/vcxdevwpadmin\/"},"uagb_comment_info":0,"uagb_excerpt":"Table of Contents Lock \/ Unlock Room Moderate Participant Entry to Session Lock \/ Unlock Room The&nbsp;EnxRoom.lockRoom()&nbsp;method allows the Moderator to lock the Room which forbids any new user from joining the Session. The Moderator can unlock the Room using EnxRoom.unLockRoom()&nbsp;method to allow subsequent users to join the Session. Class:&nbsp;EnxRoom Methods: public void lockRoom() \u2013&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4309"}],"collection":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/comments?post=4309"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4309\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3740"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4309"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}