AutoDoc:BlueSpiceCloudClient: Difference between revisions

Back to version history
Browse history interactively
← Older edit
VisualWikitext
m 1 revision imported
m 1 revision imported
 
(One intermediate revision by one other user not shown)
Line 14: Line 14:
|name = MediaWiki
|name = MediaWiki
|version = 1.39.0
|version = 1.39.0
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = 5
}}
{{AutoDocVersion
|name = BlueSpiceProDistributionConnector
|version = 5
}}
}}
}}
}}
Line 20: Line 28:
|into = {{AutoDocListItem
|into = {{AutoDocListItem
|item = BlueSpiceInstanceStatus
|item = BlueSpiceInstanceStatus
}}
{{AutoDocListItem
|item = BlueSpiceWikiFarm
}}
}}
}}
}}
Line 25: Line 36:
{{AutoDocConfig
{{AutoDocConfig
|config = {{AutoDocOption
|config = {{AutoDocOption
|name = CloudClientMessageProvider
|value = <nowiki>'BlueSpice\\CloudClient\\MessageProvider\\CIMSProvider::factory'</nowiki>
}}
{{AutoDocOption
|name = CloudClientPDFTemplatePlaceholderParams
|value = <nowiki>array (
  'logo' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\Logo::factory',
  'title' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\Title::factory',
  'subtitle' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\Subtitle::factory',
  'currentpagenumber' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\CurrentPageNumber::factory',
  'totalpagescount' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\TotalPagesCount::factory',
  'url' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\Url::factory',
  'user' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\User::factory',
  'exportdate' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\ExportDate::factory',
  'exporttime' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\ExportTime::factory',
  'coverbackground' => 'BlueSpice\\CloudClient\\PDFTemplatePlaceholderParams\\CoverBackground::factory',
)</nowiki>
}}
{{AutoDocOption
|name = CloudClientResyncOnSpecialPage
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = CloudClientStatusNotificationUserGroups
|name = CloudClientStatusNotificationUserGroups
|value = <nowiki>array (
|value = <nowiki>array (
Line 58: Line 46:
     0 => 'sysop',
     0 => 'sysop',
   ),
   ),
)</nowiki>
}}
{{AutoDocOption
|name = CloudClientUserLimitWhitelist
|value = <nowiki>array (
  0 => 'BSMaintenance',
  1 => 'WikiSysop',
  2 => 'MediaWiki default',
  3 => 'DynamicPageList3 extension',
  4 => 'BlueSpice default',
  5 => 'Maintenance script',
  6 => 'Mediawiki default',
  7 => 'Delete page script',
)</nowiki>
}}
{{AutoDocOption
|name = CloudInstanceConfig
|value = <nowiki>array (
  'instanceId' => NULL,
  'instanceToken' => NULL,
  'CIMSRestPath' => 'https://cims.bluespice.com/w/rest.php',
)</nowiki>
)</nowiki>
}}
}}
Line 85: Line 52:
{{AutoDocApiModules
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|APIModules = {{AutoDocCallback
|name = bs-cloudclient-check-messages
|callback = BlueSpice\CloudClient\Api\CheckForMessages
}}
{{AutoDocCallback
|name = bs-cloudclient-dismiss-message
|callback = BlueSpice\CloudClient\Api\DismissMessage
}}
{{AutoDocCallback
|name = bs-cloudclient-message-store
|name = bs-cloudclient-message-store
|callback = BlueSpice\CloudClient\Api\Store\Messages
|callback = BlueSpice\CloudClient\Api\Store\Messages
Line 104: Line 63:
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFCreatePDFBeforeSend BSUEModulePDFCreatePDFBeforeSend]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\CloudClient\Hook\BSUEModulePDFCreatePDFBeforeSend\ApplyCustomizations::callback
|callback = openInNewTab
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceDiscoveryAfterGetFooterPlaces BlueSpiceDiscoveryAfterGetFooterPlaces]
|callback = openInNewTab
|callback = modifyFooterLink
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChangeUserGroups ChangeUserGroups]
|callback = farmContentTransferIntegration
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = BlueSpice\CloudClient\Hook\LoadExtensionSchemaUpdates\AddMessagesTable::callback, BlueSpice\CloudClient\Hook\LoadExtensionSchemaUpdates\AddPDFTemplateMessages::callback
|callback = BlueSpice\CloudClient\Hook\LoadExtensionSchemaUpdates\AddMessagesTable::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SiteNoticeAfter SiteNoticeAfter]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SiteNoticeAfter SiteNoticeAfter]
|callback = BlueSpice\CloudClient\Hook\SiteNoticeAfter\AddMessageAlerts::callback
|callback = addMessageAlerts
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 123: Line 86:
|callback = \BlueSpice\CloudClient\Hook\UserLoggedIn\AddLogEntry::callback
|callback = \BlueSpice\CloudClient\Hook\UserLoggedIn\AddLogEntry::callback
}}
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/UserRemoveGroup UserRemoveGroup]
|callback = farmContentTransferIntegration
}}
}}
==Composer requirements==
{{AutoDocComposer requirements
|hallowelt/cloud-messages = 1.*
|all-packages = hallowelt/cloud-messages
}}
}}


Latest revision as of 10:30, 21 November 2025

DescriptionMsg

⧼bs-cloudclient-desc⧽

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.39.0
  • BlueSpiceFoundation: 5
  • BlueSpiceProDistributionConnector: 5

IntegratesInto

  • BlueSpiceInstanceStatus
  • BlueSpiceWikiFarm

Config

Configuration

Name Value
CloudClientStatusNotificationUserGroups array ( 'general' => array ( 0 => 'user', ), 'secret' => array ( 0 => 'sysop', ), )

ApiModules

API Modules

  • bs-cloudclient-message-store

Hooks

Hooks

Composer requirements

all-packages hallowelt/cloud-messages
Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceCloudClient&oldid=13362"