Skip to content

Commit 9a0560f

Browse files
author
Piwik Docs
committed
updated plugins API documentation
1 parent 2ba1d3f commit 9a0560f

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/4.x/generated/Hooks.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2634,7 +2634,7 @@ Usages:
26342634

26352635
### ScheduledReports.allowMultipleReports
26362636

2637-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [958](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L958)*
2637+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [963](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L963)*
26382638

26392639
Triggered when we're determining if a scheduled report transport medium can
26402640
handle sending multiple Matomo reports in one scheduled report or not. Plugins that provide their own transport mediums should use this
@@ -2657,7 +2657,7 @@ Usages:
26572657

26582658
### ScheduledReports.getRendererInstance
26592659

2660-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [553](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L553)*
2660+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [556](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L556)*
26612661

26622662
Triggered when obtaining a renderer instance based on the scheduled report output format. Plugins that provide new scheduled report output formats should use this event to
26632663
handle their new report formats.
@@ -2684,7 +2684,7 @@ Usages:
26842684

26852685
### ScheduledReports.getReportFormats
26862686

2687-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [1005](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L1005)*
2687+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [1010](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L1010)*
26882688

26892689
Triggered when gathering all available scheduled report formats. Plugins that provide their own scheduled report format should use
26902690
this event to make their format available.
@@ -2706,7 +2706,7 @@ Usages:
27062706

27072707
### ScheduledReports.getReportMetadata
27082708

2709-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [930](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L930)*
2709+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [935](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L935)*
27102710

27112711
TODO: change this event so it returns a list of API methods instead of report metadata arrays. Triggered when gathering the list of Matomo reports that can be used with a certain
27122712
transport medium.
@@ -2732,7 +2732,7 @@ Usages:
27322732

27332733
### ScheduledReports.getReportParameters
27342734

2735-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [760](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L760)*
2735+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [765](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L765)*
27362736

27372737
Triggered when gathering the available parameters for a scheduled report type. Plugins that provide their own scheduled report transport mediums should use this
27382738
event to list the available report parameters for their transport medium.
@@ -2754,7 +2754,7 @@ Usages:
27542754

27552755
### ScheduledReports.getReportRecipients
27562756

2757-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [1036](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L1036)*
2757+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [1041](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L1041)*
27582758

27592759
Triggered when getting the list of recipients of a scheduled report. Plugins that provide their own scheduled report transport medium should use this event
27602760
to extract the list of recipients their backend's specific scheduled report
@@ -2781,7 +2781,7 @@ Usages:
27812781

27822782
### ScheduledReports.getReportTypes
27832783

2784-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [981](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L981)*
2784+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [986](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L986)*
27852785

27862786
Triggered when gathering all available transport mediums. Plugins that provide their own transport mediums should use this
27872787
event to make their medium available.
@@ -2799,7 +2799,7 @@ Usages:
27992799

28002800
### ScheduledReports.processReports
28012801

2802-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [531](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L531)*
2802+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [534](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L534)*
28032803

28042804
Triggered when generating the content of scheduled reports. This event can be used to modify the report data or report metadata of one or more reports
28052805
in a scheduled report, before the scheduled report is rendered and delivered.
@@ -2828,7 +2828,7 @@ Usages:
28282828

28292829
### ScheduledReports.sendReport
28302830

2831-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [695](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L695)*
2831+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [699](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L699)*
28322832

28332833
Triggered when sending scheduled reports. Plugins that provide new scheduled report transport mediums should use this event to
28342834
send the scheduled report.
@@ -2871,7 +2871,7 @@ Usages:
28712871

28722872
### ScheduledReports.validateReportParameters
28732873

2874-
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [787](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L787)*
2874+
*Defined in [Piwik/Plugins/ScheduledReports/API](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php) in line [792](https://github.com/matomo-org/matomo/blob/4.x-dev/plugins/ScheduledReports/API.php#L792)*
28752875

28762876
Triggered when validating the parameters for a scheduled report. Plugins that provide their own scheduled reports backend should use this
28772877
event to validate the custom parameters defined with ScheduledReports::getReportParameters().

0 commit comments

Comments
 (0)