1 line
18 KiB
JSON
1 line
18 KiB
JSON
[{"data":1,"prerenderedAt":804},["ShallowReactive",2],{"navigation_docs":3,"-essentials-notifications":80,"-essentials-notifications-surround":799},[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":791,"extension":792,"links":793,"meta":794,"navigation":795,"path":57,"seo":796,"stem":58,"__hash__":798},"docs\u002F2.essentials\u002F6.notifications.md",{"type":83,"value":84,"toc":773},"minimark",[85,90,94,99,102,106,109,113,196,207,271,275,278,282,316,319,329,333,336,340,505,509,594,598,602,605,663,669,672,676,679,721,728,732,766,769],[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\\Models\\Subscription;\n\n\u002F\u002F Check subscription status\nSubscription::isSubscribed($commentable, $user);\n\n\u002F\u002F Subscribe\u002Funsubscribe\nSubscription::subscribe($commentable, $user);\nSubscription::unsubscribe($commentable, $user);\n\n\u002F\u002F Get all subscribers for a commentable\n$subscribers = Subscription::subscribersFor($commentable);\n",[121,344,345,374,380,385,414,418,424,446,468,473,479],{"__ignoreMap":119},[124,346,347,351,355,358,361,363,366,368,371],{"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},"Models",[124,367,357],{"class":137},[124,369,370],{"class":353},"Subscription",[124,372,373],{"class":137},";\n",[124,375,376],{"class":126,"line":134},[124,377,379],{"emptyLinePlaceholder":378},true,"\n",[124,381,382],{"class":126,"line":153},[124,383,384],{"class":130},"\u002F\u002F Check subscription status\n",[124,386,387,390,393,397,400,403,405,408,411],{"class":126,"line":178},[124,388,370],{"class":389},"sBMFI",[124,391,392],{"class":137},"::",[124,394,396],{"class":395},"s2Zo4","isSubscribed",[124,398,399],{"class":137},"($",[124,401,402],{"class":353},"commentable",[124,404,244],{"class":137},[124,406,407],{"class":137}," $",[124,409,410],{"class":353},"user",[124,412,413],{"class":137},");\n",[124,415,416],{"class":126,"line":193},[124,417,379],{"emptyLinePlaceholder":378},[124,419,421],{"class":126,"line":420},6,[124,422,423],{"class":130},"\u002F\u002F Subscribe\u002Funsubscribe\n",[124,425,427,429,431,434,436,438,440,442,444],{"class":126,"line":426},7,[124,428,370],{"class":389},[124,430,392],{"class":137},[124,432,433],{"class":395},"subscribe",[124,435,399],{"class":137},[124,437,402],{"class":353},[124,439,244],{"class":137},[124,441,407],{"class":137},[124,443,410],{"class":353},[124,445,413],{"class":137},[124,447,449,451,453,456,458,460,462,464,466],{"class":126,"line":448},8,[124,450,370],{"class":389},[124,452,392],{"class":137},[124,454,455],{"class":395},"unsubscribe",[124,457,399],{"class":137},[124,459,402],{"class":353},[124,461,244],{"class":137},[124,463,407],{"class":137},[124,465,410],{"class":353},[124,467,413],{"class":137},[124,469,471],{"class":126,"line":470},9,[124,472,379],{"emptyLinePlaceholder":378},[124,474,476],{"class":126,"line":475},10,[124,477,478],{"class":130},"\u002F\u002F Get all subscribers for a commentable\n",[124,480,482,485,488,491,494,496,499,501,503],{"class":126,"line":481},11,[124,483,484],{"class":137},"$",[124,486,487],{"class":353},"subscribers ",[124,489,490],{"class":137},"=",[124,492,493],{"class":389}," Subscription",[124,495,392],{"class":137},[124,497,498],{"class":395},"subscribersFor",[124,500,399],{"class":137},[124,502,402],{"class":353},[124,504,413],{"class":137},[86,506,508],{"id":507},"events","Events",[510,511,512,528],"table",{},[513,514,515],"thead",{},[516,517,518,522,525],"tr",{},[519,520,521],"th",{},"Event",[519,523,524],{},"Trigger",[519,526,527],{},"Broadcasts",[529,530,531,545,557,569,581],"tbody",{},[516,532,533,539,542],{},[534,535,536],"td",{},[121,537,538],{},"CommentCreated",[534,540,541],{},"New comment or reply",[534,543,544],{},"Yes",[516,546,547,552,555],{},[534,548,549],{},[121,550,551],{},"CommentUpdated",[534,553,554],{},"Comment edited",[534,556,544],{},[516,558,559,564,567],{},[534,560,561],{},[121,562,563],{},"CommentDeleted",[534,565,566],{},"Comment soft-deleted",[534,568,544],{},[516,570,571,576,579],{},[534,572,573],{},[121,574,575],{},"CommentReacted",[534,577,578],{},"Reaction added\u002Fremoved",[534,580,544],{},[516,582,583,588,591],{},[534,584,585],{},[121,586,587],{},"UserMentioned",[534,589,590],{},"User @mentioned",[534,592,593],{},"No",[86,595,597],{"id":596},"real-time-updates","Real-time Updates",[95,599,601],{"id":600},"broadcasting","Broadcasting",[91,603,604],{},"Enable broadcasting for instant updates across browser sessions:",[114,606,608],{"className":116,"code":607,"language":118,"meta":119,"style":119},"\u002F\u002F config\u002Fcomments.php\n'broadcasting' => [\n 'enabled' => true,\n 'channel_prefix' => 'comments',\n],\n",[121,609,610,614,626,638,659],{"__ignoreMap":119},[124,611,612],{"class":126,"line":127},[124,613,131],{"class":130},[124,615,616,618,620,622,624],{"class":126,"line":134},[124,617,138],{"class":137},[124,619,600],{"class":141},[124,621,138],{"class":137},[124,623,147],{"class":137},[124,625,150],{"class":137},[124,627,628,630,632,634,636],{"class":126,"line":153},[124,629,156],{"class":137},[124,631,183],{"class":141},[124,633,138],{"class":137},[124,635,147],{"class":137},[124,637,190],{"class":137},[124,639,640,642,645,647,649,651,654,656],{"class":126,"line":178},[124,641,156],{"class":137},[124,643,644],{"class":141},"channel_prefix",[124,646,138],{"class":137},[124,648,147],{"class":137},[124,650,247],{"class":137},[124,652,653],{"class":141},"comments",[124,655,138],{"class":137},[124,657,658],{"class":137},",\n",[124,660,661],{"class":126,"line":193},[124,662,175],{"class":137},[91,664,665,666],{},"Events are broadcast on private channels: ",[121,667,668],{},"{prefix}.{commentable_type}.{commentable_id}",[91,670,671],{},"This requires Laravel Echo and a broadcasting driver (Pusher, Ably, etc.) configured in your application.",[95,673,675],{"id":674},"polling-fallback","Polling Fallback",[91,677,678],{},"When broadcasting is disabled, the Livewire component polls for updates:",[114,680,682],{"className":116,"code":681,"language":118,"meta":119,"style":119},"'polling' => [\n 'interval' => '10s',\n],\n",[121,683,684,697,717],{"__ignoreMap":119},[124,685,686,688,691,693,695],{"class":126,"line":127},[124,687,138],{"class":137},[124,689,690],{"class":141},"polling",[124,692,138],{"class":137},[124,694,147],{"class":137},[124,696,150],{"class":137},[124,698,699,701,704,706,708,710,713,715],{"class":126,"line":134},[124,700,156],{"class":137},[124,702,703],{"class":141},"interval",[124,705,138],{"class":137},[124,707,147],{"class":137},[124,709,247],{"class":137},[124,711,712],{"class":141},"10s",[124,714,138],{"class":137},[124,716,658],{"class":137},[124,718,719],{"class":126,"line":153},[124,720,175],{"class":137},[91,722,723,724,727],{},"Set to ",[121,725,726],{},"null"," to disable polling entirely.",[86,729,731],{"id":730},"disabling-notifications","Disabling Notifications",[114,733,735],{"className":116,"code":734,"language":118,"meta":119,"style":119},"'notifications' => [\n 'enabled' => false,\n],\n",[121,736,737,749,762],{"__ignoreMap":119},[124,738,739,741,743,745,747],{"class":126,"line":127},[124,740,138],{"class":137},[124,742,142],{"class":141},[124,744,138],{"class":137},[124,746,147],{"class":137},[124,748,150],{"class":137},[124,750,751,753,755,757,759],{"class":126,"line":134},[124,752,156],{"class":137},[124,754,183],{"class":141},[124,756,138],{"class":137},[124,758,147],{"class":137},[124,760,761],{"class":137}," false,\n",[124,763,764],{"class":126,"line":153},[124,765,175],{"class":137},[91,767,768],{},"This disables all notification dispatching. Subscriptions and events still work, but no notifications are sent.",[770,771,772],"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":774},[775,779,780,785,786,790],{"id":88,"depth":134,"text":89,"children":776},[777,778],{"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":781},[782,783,784],{"id":280,"depth":153,"text":281},{"id":331,"depth":153,"text":332},{"id":338,"depth":153,"text":339},{"id":507,"depth":134,"text":508},{"id":596,"depth":134,"text":597,"children":787},[788,789],{"id":600,"depth":153,"text":601},{"id":674,"depth":153,"text":675},{"id":730,"depth":134,"text":731},"Comment notifications, subscriptions, and real-time updates.","md",null,{},{"icon":59},{"description":797,"title":56},"Configure comment notifications, subscriptions, broadcasting, and polling.","drotOcQFMBQs0KXJ02mt95uFAuJkVVeqmKiZga1ki1c",[800,802],{"title":51,"path":52,"stem":53,"description":801,"icon":54,"children":-1},"File uploads for comments.",{"title":61,"path":62,"stem":63,"description":803,"icon":64,"children":-1},"Tables, relationships, and indexes used by the Comments package.",1774609385105] |