Documentation

AbstractReportingCloud

in package

• Application

Abstract ReportingCloud

Table of Contents

Constants

DEFAULT_BASE_URI  = 'https://api.reporting.cloud'

Default base URI of backend

DEFAULT_DATE_FORMAT  = 'Y-m-d\\TH:i:sP'

Default date/time format of backend is 'ISO 8601'

DEFAULT_TIME_ZONE  = 'UTC'

Default time zone of backend

DOCUMENT_DIVIDER_NEW_PARAGRAPH  = 2

Document divider - new paragraph

DOCUMENT_DIVIDER_NEW_SECTION  = 3

Document divider - new section

DOCUMENT_DIVIDER_NONE  = 1

Document divider - none

FILE_FORMAT_BMP  = 'BMP'

Bitmap file format

FILE_FORMAT_DOC  = 'DOC'

DOC file format

FILE_FORMAT_DOCX  = 'DOCX'

DOCX file format

FILE_FORMAT_GIF  = 'GIF'

GIF file format

FILE_FORMAT_HTML  = 'HTML'

HTML file format

FILE_FORMAT_JPG  = 'JPG'

JPEG file format

FILE_FORMAT_PDF  = 'PDF'

PDF file format

FILE_FORMAT_PDFA  = 'PDFA'

PDF/A file format

FILE_FORMAT_PNG  = 'PNG'

PNG file format

FILE_FORMAT_RTF  = 'RTF'

RTF file format

FILE_FORMAT_TX  = 'TX'

TX (Text Control) file format

FILE_FORMAT_TXT  = 'TXT'

Pure text file format

FILE_FORMAT_XLSX  = 'XLSX'

XLSX file format

FILE_FORMATS_DOCUMENT  = [self::FILE_FORMAT_DOC, self::FILE_FORMAT_DOCX, self::FILE_FORMAT_HTML, self::FILE_FORMAT_PDF, self::FILE_FORMAT_RTF, self::FILE_FORMAT_TX]

Document file formats

FILE_FORMATS_IMAGE  = [self::FILE_FORMAT_BMP, self::FILE_FORMAT_GIF, self::FILE_FORMAT_JPG, self::FILE_FORMAT_PNG]

Image file formats

FILE_FORMATS_RETURN  = [self::FILE_FORMAT_DOC, self::FILE_FORMAT_DOCX, self::FILE_FORMAT_HTML, self::FILE_FORMAT_PDF, self::FILE_FORMAT_PDFA, self::FILE_FORMAT_RTF, self::FILE_FORMAT_TX, self::FILE_FORMAT_TXT]

Return file formats

FILE_FORMATS_TEMPLATE  = [self::FILE_FORMAT_DOC, self::FILE_FORMAT_DOCX, self::FILE_FORMAT_RTF, self::FILE_FORMAT_TX]

Template file formats

HIGHLIGHT_MODE_ACTIVATED  = 2

Activated highlight mode

HIGHLIGHT_MODE_ALWAYS  = 3

Always highlight mode

HIGHLIGHT_MODE_NEVER  = 1

Never highlight mode

TRACKED_CHANGE_DELETED_TEXT  = 8192

DeletedText tracked change

TRACKED_CHANGE_INSERTED_TEXT  = 4096

InsertedText tracked change

DEFAULT_DEBUG  = false

Default debug flag of REST client

DEFAULT_TEST  = false

Default test flag of backend

DEFAULT_TIMEOUT  = 120

Default timeout of backend in seconds

DEFAULT_VERSION  = 'v1'

Default version string of backend

Properties

$apiKey  : string

Backend API key

$baseUri  : string

Backend base URI

$client  : Client

REST client to backend

$debug  : bool

Debug flag of REST client

$password  : string

Backend password

$test  : bool

When true, API call does not count against quota "TEST MODE" watermark is added to document

$timeout  : int

Backend timeout in seconds

$username  : string

Backend username

$version  : string

Backend version string

Methods

getApiKey()  : string

Return the API key

getBaseUri()  : string

Return the base URI of the backend web service

getClient()  : Client

Return the REST client of the backend web service

getDebug()  : bool

Return the debug flag

getPassword()  : string

Return the password

getTest()  : bool

Return the test flag

getTimeout()  : int

Get the timeout (in seconds) of the backend web service

getUsername()  : string

Return the username

getVersion()  : string

Get the version string of the backend web service

setApiKey()  : self

Set the API key

setBaseUri()  : self

Set the base URI of the backend web service

setClient()  : self

Set the REST client of the backend web service

setDebug()  : self

Set the debug flag

setPassword()  : self

Set the password

setTest()  : self

Set the test flag

setTimeout()  : self

Set the timeout (in seconds) of the backend web service

setUsername()  : self

Set the username

setVersion()  : self

Set the version string of the backend web service

request()  : ResponseInterface

Request the URI with options

uri()  : string

Construct URI with version number

getAuthorizationHeader()  : string

Return Authorization Header, with either API key or username and password