1 line
18 KiB
JSON
1 line
18 KiB
JSON
[{"data":1,"prerenderedAt":799},["ShallowReactive",2],{"navigation_docs":3,"-essentials-notifications":80,"-essentials-notifications-surround":794},[4,25,65],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"\u002Fgetting-started","1.getting-started",[10,15,20],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction","i-lucide-home",{"title":16,"path":17,"stem":18,"icon":19},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"Upgrading","\u002Fgetting-started\u002Fupgrading","1.getting-started\u002F3.upgrading","i-lucide-arrow-up-circle",{"title":26,"path":27,"stem":28,"children":29,"page":6},"Essentials","\u002Fessentials","2.essentials",[30,35,40,45,50,55,60],{"title":31,"path":32,"stem":33,"icon":34},"Configuration","\u002Fessentials\u002Fconfiguration","2.essentials\u002F1.configuration","i-lucide-settings",{"title":36,"path":37,"stem":38,"icon":39},"Authorization","\u002Fessentials\u002Fauthorization","2.essentials\u002F2.authorization","i-lucide-shield",{"title":41,"path":42,"stem":43,"icon":44},"Mentions","\u002Fessentials\u002Fmentions","2.essentials\u002F3.mentions","i-lucide-at-sign",{"title":46,"path":47,"stem":48,"icon":49},"Reactions","\u002Fessentials\u002Freactions","2.essentials\u002F4.reactions","i-lucide-smile",{"title":51,"path":52,"stem":53,"icon":54},"Attachments","\u002Fessentials\u002Fattachments","2.essentials\u002F5.attachments","i-lucide-paperclip",{"title":56,"path":57,"stem":58,"icon":59},"Notifications","\u002Fessentials\u002Fnotifications","2.essentials\u002F6.notifications","i-lucide-bell",{"title":61,"path":62,"stem":63,"icon":64},"Database Schema","\u002Fessentials\u002Fdatabase-schema","2.essentials\u002F7.database-schema","i-lucide-database",{"title":66,"path":67,"stem":68,"children":69,"page":6},"Community","\u002Fcommunity","4.community",[70,75],{"title":71,"path":72,"stem":73,"icon":74},"Contributing","\u002Fcommunity\u002Fcontributing","4.community\u002F1.contributing","i-lucide-heart-handshake",{"title":76,"path":77,"stem":78,"icon":79},"License","\u002Fcommunity\u002Flicense","4.community\u002F2.license","i-lucide-scale",{"id":81,"title":56,"body":82,"description":786,"extension":787,"links":788,"meta":789,"navigation":790,"path":57,"seo":791,"stem":58,"__hash__":793},"docs\u002F2.essentials\u002F6.notifications.md",{"type":83,"value":84,"toc":768},"minimark",[85,90,94,99,102,106,109,113,196,207,271,275,278,282,316,319,329,333,336,340,500,504,589,593,597,600,658,664,667,671,674,716,723,727,761,764],[86,87,89],"h2",{"id":88},"notification-types","Notification Types",[91,92,93],"p",{},"Two notification classes are included:",[95,96,98],"h3",{"id":97},"commentrepliednotification","CommentRepliedNotification",[91,100,101],{},"Sent to all thread subscribers when a new comment or reply is posted. The comment author is excluded from receiving their own notification.",[95,103,105],{"id":104},"usermentionednotification","UserMentionedNotification",[91,107,108],{},"Sent to a user when they are @mentioned in a comment. Self-mentions are ignored.",[86,110,112],{"id":111},"channels","Channels",[114,115,120],"pre",{"className":116,"code":117,"language":118,"meta":119,"style":119},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","\u002F\u002F config\u002Fcomments.php\n'notifications' => [\n 'channels' => ['database'],\n 'enabled' => true,\n],\n","php","",[121,122,123,132,151,176,191],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,131],{"class":130},"sHwdD","\u002F\u002F config\u002Fcomments.php\n",[124,133,135,139,143,145,148],{"class":126,"line":134},2,[124,136,138],{"class":137},"sMK4o","'",[124,140,142],{"class":141},"sfazB","notifications",[124,144,138],{"class":137},[124,146,147],{"class":137}," =>",[124,149,150],{"class":137}," [\n",[124,152,154,157,159,161,163,166,168,171,173],{"class":126,"line":153},3,[124,155,156],{"class":137}," '",[124,158,111],{"class":141},[124,160,138],{"class":137},[124,162,147],{"class":137},[124,164,165],{"class":137}," [",[124,167,138],{"class":137},[124,169,170],{"class":141},"database",[124,172,138],{"class":137},[124,174,175],{"class":137},"],\n",[124,177,179,181,184,186,188],{"class":126,"line":178},4,[124,180,156],{"class":137},[124,182,183],{"class":141},"enabled",[124,185,138],{"class":137},[124,187,147],{"class":137},[124,189,190],{"class":137}," true,\n",[124,192,194],{"class":126,"line":193},5,[124,195,175],{"class":137},[91,197,198,199,202,203,206],{},"Available channels: ",[121,200,201],{},"'database'"," and ",[121,204,205],{},"'mail'",". Add both to send email notifications alongside database notifications:",[114,208,210],{"className":116,"code":209,"language":118,"meta":119,"style":119},"'notifications' => [\n 'channels' => ['database', 'mail'],\n 'enabled' => true,\n],\n",[121,211,212,224,255,267],{"__ignoreMap":119},[124,213,214,216,218,220,222],{"class":126,"line":127},[124,215,138],{"class":137},[124,217,142],{"class":141},[124,219,138],{"class":137},[124,221,147],{"class":137},[124,223,150],{"class":137},[124,225,226,228,230,232,234,236,238,240,242,245,248,251,253],{"class":126,"line":134},[124,227,156],{"class":137},[124,229,111],{"class":141},[124,231,138],{"class":137},[124,233,147],{"class":137},[124,235,165],{"class":137},[124,237,138],{"class":137},[124,239,170],{"class":141},[124,241,138],{"class":137},[124,243,244],{"class":137},",",[124,246,247],{"class":137}," '",[124,249,250],{"class":141},"mail",[124,252,138],{"class":137},[124,254,175],{"class":137},[124,256,257,259,261,263,265],{"class":126,"line":153},[124,258,156],{"class":137},[124,260,183],{"class":141},[124,262,138],{"class":137},[124,264,147],{"class":137},[124,266,190],{"class":137},[124,268,269],{"class":126,"line":178},[124,270,175],{"class":137},[86,272,274],{"id":273},"subscriptions","Subscriptions",[91,276,277],{},"Users can subscribe to comment threads on any commentable model. Subscribers receive notifications when new comments are posted.",[95,279,281],{"id":280},"auto-subscribe","Auto-Subscribe",[114,283,285],{"className":116,"code":284,"language":118,"meta":119,"style":119},"'subscriptions' => [\n 'auto_subscribe' => true,\n],\n",[121,286,287,299,312],{"__ignoreMap":119},[124,288,289,291,293,295,297],{"class":126,"line":127},[124,290,138],{"class":137},[124,292,273],{"class":141},[124,294,138],{"class":137},[124,296,147],{"class":137},[124,298,150],{"class":137},[124,300,301,303,306,308,310],{"class":126,"line":134},[124,302,156],{"class":137},[124,304,305],{"class":141},"auto_subscribe",[124,307,138],{"class":137},[124,309,147],{"class":137},[124,311,190],{"class":137},[124,313,314],{"class":126,"line":153},[124,315,175],{"class":137},[91,317,318],{},"When enabled:",[320,321,322,326],"ul",{},[323,324,325],"li",{},"Users are auto-subscribed when they post a comment",[323,327,328],{},"Users are auto-subscribed when they are @mentioned",[95,330,332],{"id":331},"manual-subscription","Manual Subscription",[91,334,335],{},"Users can toggle their subscription using the subscribe\u002Funsubscribe button in the comments UI.",[95,337,339],{"id":338},"programmatic-access","Programmatic Access",[114,341,343],{"className":116,"code":342,"language":118,"meta":119,"style":119},"use Relaticle\\Comments\\CommentSubscription;\n\n\u002F\u002F Check subscription status\nCommentSubscription::isSubscribed($commentable, $user);\n\n\u002F\u002F Subscribe\u002Funsubscribe\nCommentSubscription::subscribe($commentable, $user);\nCommentSubscription::unsubscribe($commentable, $user);\n\n\u002F\u002F Get all subscribers for a commentable\n$subscribers = CommentSubscription::subscribersFor($commentable);\n",[121,344,345,369,375,380,409,413,419,441,463,468,474],{"__ignoreMap":119},[124,346,347,351,355,358,361,363,366],{"class":126,"line":127},[124,348,350],{"class":349},"sbssI","use",[124,352,354],{"class":353},"sTEyZ"," Relaticle",[124,356,357],{"class":137},"\\",[124,359,360],{"class":353},"Comments",[124,362,357],{"class":137},[124,364,365],{"class":353},"CommentSubscription",[124,367,368],{"class":137},";\n",[124,370,371],{"class":126,"line":134},[124,372,374],{"emptyLinePlaceholder":373},true,"\n",[124,376,377],{"class":126,"line":153},[124,378,379],{"class":130},"\u002F\u002F Check subscription status\n",[124,381,382,385,388,392,395,398,400,403,406],{"class":126,"line":178},[124,383,365],{"class":384},"sBMFI",[124,386,387],{"class":137},"::",[124,389,391],{"class":390},"s2Zo4","isSubscribed",[124,393,394],{"class":137},"($",[124,396,397],{"class":353},"commentable",[124,399,244],{"class":137},[124,401,402],{"class":137}," $",[124,404,405],{"class":353},"user",[124,407,408],{"class":137},");\n",[124,410,411],{"class":126,"line":193},[124,412,374],{"emptyLinePlaceholder":373},[124,414,416],{"class":126,"line":415},6,[124,417,418],{"class":130},"\u002F\u002F Subscribe\u002Funsubscribe\n",[124,420,422,424,426,429,431,433,435,437,439],{"class":126,"line":421},7,[124,423,365],{"class":384},[124,425,387],{"class":137},[124,427,428],{"class":390},"subscribe",[124,430,394],{"class":137},[124,432,397],{"class":353},[124,434,244],{"class":137},[124,436,402],{"class":137},[124,438,405],{"class":353},[124,440,408],{"class":137},[124,442,444,446,448,451,453,455,457,459,461],{"class":126,"line":443},8,[124,445,365],{"class":384},[124,447,387],{"class":137},[124,449,450],{"class":390},"unsubscribe",[124,452,394],{"class":137},[124,454,397],{"class":353},[124,456,244],{"class":137},[124,458,402],{"class":137},[124,460,405],{"class":353},[124,462,408],{"class":137},[124,464,466],{"class":126,"line":465},9,[124,467,374],{"emptyLinePlaceholder":373},[124,469,471],{"class":126,"line":470},10,[124,472,473],{"class":130},"\u002F\u002F Get all subscribers for a commentable\n",[124,475,477,480,483,486,489,491,494,496,498],{"class":126,"line":476},11,[124,478,479],{"class":137},"$",[124,481,482],{"class":353},"subscribers ",[124,484,485],{"class":137},"=",[124,487,488],{"class":384}," CommentSubscription",[124,490,387],{"class":137},[124,492,493],{"class":390},"subscribersFor",[124,495,394],{"class":137},[124,497,397],{"class":353},[124,499,408],{"class":137},[86,501,503],{"id":502},"events","Events",[505,506,507,523],"table",{},[508,509,510],"thead",{},[511,512,513,517,520],"tr",{},[514,515,516],"th",{},"Event",[514,518,519],{},"Trigger",[514,521,522],{},"Broadcasts",[524,525,526,540,552,564,576],"tbody",{},[511,527,528,534,537],{},[529,530,531],"td",{},[121,532,533],{},"CommentCreated",[529,535,536],{},"New comment or reply",[529,538,539],{},"Yes",[511,541,542,547,550],{},[529,543,544],{},[121,545,546],{},"CommentUpdated",[529,548,549],{},"Comment edited",[529,551,539],{},[511,553,554,559,562],{},[529,555,556],{},[121,557,558],{},"CommentDeleted",[529,560,561],{},"Comment soft-deleted",[529,563,539],{},[511,565,566,571,574],{},[529,567,568],{},[121,569,570],{},"CommentReacted",[529,572,573],{},"Reaction added\u002Fremoved",[529,575,539],{},[511,577,578,583,586],{},[529,579,580],{},[121,581,582],{},"UserMentioned",[529,584,585],{},"User @mentioned",[529,587,588],{},"No",[86,590,592],{"id":591},"real-time-updates","Real-time Updates",[95,594,596],{"id":595},"broadcasting","Broadcasting",[91,598,599],{},"Enable broadcasting for instant updates across browser sessions:",[114,601,603],{"className":116,"code":602,"language":118,"meta":119,"style":119},"\u002F\u002F config\u002Fcomments.php\n'broadcasting' => [\n 'enabled' => true,\n 'channel_prefix' => 'comments',\n],\n",[121,604,605,609,621,633,654],{"__ignoreMap":119},[124,606,607],{"class":126,"line":127},[124,608,131],{"class":130},[124,610,611,613,615,617,619],{"class":126,"line":134},[124,612,138],{"class":137},[124,614,595],{"class":141},[124,616,138],{"class":137},[124,618,147],{"class":137},[124,620,150],{"class":137},[124,622,623,625,627,629,631],{"class":126,"line":153},[124,624,156],{"class":137},[124,626,183],{"class":141},[124,628,138],{"class":137},[124,630,147],{"class":137},[124,632,190],{"class":137},[124,634,635,637,640,642,644,646,649,651],{"class":126,"line":178},[124,636,156],{"class":137},[124,638,639],{"class":141},"channel_prefix",[124,641,138],{"class":137},[124,643,147],{"class":137},[124,645,247],{"class":137},[124,647,648],{"class":141},"comments",[124,650,138],{"class":137},[124,652,653],{"class":137},",\n",[124,655,656],{"class":126,"line":193},[124,657,175],{"class":137},[91,659,660,661],{},"Events are broadcast on private channels: ",[121,662,663],{},"{prefix}.{commentable_type}.{commentable_id}",[91,665,666],{},"This requires Laravel Echo and a broadcasting driver (Pusher, Ably, etc.) configured in your application.",[95,668,670],{"id":669},"polling-fallback","Polling Fallback",[91,672,673],{},"When broadcasting is disabled, the Livewire component polls for updates:",[114,675,677],{"className":116,"code":676,"language":118,"meta":119,"style":119},"'polling' => [\n 'interval' => '10s',\n],\n",[121,678,679,692,712],{"__ignoreMap":119},[124,680,681,683,686,688,690],{"class":126,"line":127},[124,682,138],{"class":137},[124,684,685],{"class":141},"polling",[124,687,138],{"class":137},[124,689,147],{"class":137},[124,691,150],{"class":137},[124,693,694,696,699,701,703,705,708,710],{"class":126,"line":134},[124,695,156],{"class":137},[124,697,698],{"class":141},"interval",[124,700,138],{"class":137},[124,702,147],{"class":137},[124,704,247],{"class":137},[124,706,707],{"class":141},"10s",[124,709,138],{"class":137},[124,711,653],{"class":137},[124,713,714],{"class":126,"line":153},[124,715,175],{"class":137},[91,717,718,719,722],{},"Set to ",[121,720,721],{},"null"," to disable polling entirely.",[86,724,726],{"id":725},"disabling-notifications","Disabling Notifications",[114,728,730],{"className":116,"code":729,"language":118,"meta":119,"style":119},"'notifications' => [\n 'enabled' => false,\n],\n",[121,731,732,744,757],{"__ignoreMap":119},[124,733,734,736,738,740,742],{"class":126,"line":127},[124,735,138],{"class":137},[124,737,142],{"class":141},[124,739,138],{"class":137},[124,741,147],{"class":137},[124,743,150],{"class":137},[124,745,746,748,750,752,754],{"class":126,"line":134},[124,747,156],{"class":137},[124,749,183],{"class":141},[124,751,138],{"class":137},[124,753,147],{"class":137},[124,755,756],{"class":137}," false,\n",[124,758,759],{"class":126,"line":153},[124,760,175],{"class":137},[91,762,763],{},"This disables all notification dispatching. Subscriptions and events still work, but no notifications are sent.",[765,766,767],"style",{},"html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}",{"title":119,"searchDepth":134,"depth":134,"links":769},[770,774,775,780,781,785],{"id":88,"depth":134,"text":89,"children":771},[772,773],{"id":97,"depth":153,"text":98},{"id":104,"depth":153,"text":105},{"id":111,"depth":134,"text":112},{"id":273,"depth":134,"text":274,"children":776},[777,778,779],{"id":280,"depth":153,"text":281},{"id":331,"depth":153,"text":332},{"id":338,"depth":153,"text":339},{"id":502,"depth":134,"text":503},{"id":591,"depth":134,"text":592,"children":782},[783,784],{"id":595,"depth":153,"text":596},{"id":669,"depth":153,"text":670},{"id":725,"depth":134,"text":726},"Comment notifications, subscriptions, and real-time updates.","md",null,{},{"icon":59},{"description":792,"title":56},"Configure comment notifications, subscriptions, broadcasting, and polling.","IShzf0gxRwqSzEvhZKCCHfv_bSAPbP2T6TYVaQvFsEo",[795,797],{"title":51,"path":52,"stem":53,"description":796,"icon":54,"children":-1},"File uploads for comments.",{"title":61,"path":62,"stem":63,"description":798,"icon":64,"children":-1},"Tables, relationships, and indexes used by the Comments package.",1774607320591] |