Options
All
  • Public
  • Public/Protected
  • All
Menu

ReportAction describes an action that opens a report and performs one or more sub-actions on it. ReportAction has the value of 'report' for the actionType property.

Hierarchy

  • ReportAction

Index

Properties

Optional csv

csv: undefined | string

The server-side path to save the report to as a CSV file.

Optional emails

emails: string[]

The email address to which the report should be sent.

Optional format

format: undefined | string

The format in which the report should be sent in the delivery emails. The allowable values are "CSV', 'EXCEL', 'EXCEL_DATA', 'EXCEL_SHEET', 'HTML_BUNDLE', 'HTML_BUNDLE_NO_PAGINATION', 'HTML_NO_PAGINATION_EMAIL', 'PDF', 'POSTSCRIPT', 'POWERPOINT', 'RTF', 'RTF_LAYOUT', 'SVG', 'TEXT', and 'XML'.

Optional htmlMessage

htmlMessage: undefined | false | true

A flag indicating if the message body is formatted as HTML.

Optional locale

locale: undefined | string

The locale to use when running the report.

Optional message

message: undefined | string

The message body of the delivery and/or notification emails.

Optional notifies

notifies: string[]

The email addresses to which a notification email should be sent that the action has been performed.

Optional parameters

parameters: undefined | object

The parameters to use when opening the report.

Optional pdf

pdf: undefined | string

The server-side path to save the report to as a PDF.

Optional printers

printers: string[]

The names of the printers to which the report should be printed.

report

report: string

The path to the report.

Optional sender

sender: undefined | string

The email address from which the delivery and/or notification emails are sent.

Optional subject

subject: undefined | string

The subject of the delivery and/or notification emails.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc