Aculab Web Services Wrapper (v1.2.0)
\
Aculab
WebServicesWrapper
VoiceBiometrics
Users

\Aculab\WebServicesWrapperApplicationDataRecord

The application data record contains details of the application instance.

Returned by \Aculab\WebServicesWrapper\ApplicationStatus::getApplicationDataRecord()

Summary

Methods
Properties
Constants
getApplicationInstanceId()
getApplicationName()
getUasIpAddress()
getUasName()
getExitStatus()
getStartTime()
getStopTime()
getDuration()
getOutboundParameters()
getApplicationParameters()
getExtraChannelCount()
getFaxEnabled()
getTotalCost()
getPstnCost()
getPlatformCost()
getTollfreeCost()
getExtraCost()
getCostsValid()
getRestLogFilename()
getRestTo()
getRestFrom()
getRestInitialToken()
getTTSCost()
getTTSUnitCost()
getTTSSeconds()
getFeatureCost()
getFeatureSeconds()
getTTSNeuralSeconds()
getTTSNeuralUnitCost()
getTTSNeuralCost()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getApplicationInstanceId()

getApplicationInstanceId() : string

Get the application instance's unique ID.

Returns

string

getApplicationName()

getApplicationName() : string

Get the name of the application.

Returns

string

getUasIpAddress()

getUasIpAddress() : string

Get the IP address of the UAS server.

Returns

string

getUasName()

getUasName() : string

Get the name of the UAS server.

Returns

string

getExitStatus()

getExitStatus() : integer

Get the numeric return code passed back by the application instance.

Returns

integer

getStartTime()

getStartTime() : \DateTime

Get the time at which the application instance started.

Returns

\DateTime

getStopTime()

getStopTime() : \DateTime

Get the time at which the application instance stopped.

Returns

\DateTime

getDuration()

getDuration() : float

Get the duration of the application instance in seconds.

Returns

float

getOutboundParameters()

getOutboundParameters() : string

Get a shortened representation of the outbound parameters passed to the application instance.

Returns

string

getApplicationParameters()

getApplicationParameters() : string

Get a shortened representation of the application parameters sent to the application instance.

Returns

string

getExtraChannelCount()

getExtraChannelCount() : integer

Get the number of extra channels configured for the application instance.

Returns

integer

getFaxEnabled()

getFaxEnabled() : boolean

Determine if fax is enabled on the service.

Returns

boolean

getTotalCost()

getTotalCost() : float

Get the total cost for the application instance.

Returns

float

getPstnCost()

getPstnCost() : float

Get the cost of any outbound PSTN telephone calls.

Returns

float

getPlatformCost()

getPlatformCost() : float

Get the Aculab Cloud platform cost for the instance.

Returns

float

getTollfreeCost()

getTollfreeCost() : float

Get the cost of any toll free telephone calls.

Returns

float

getExtraCost()

getExtraCost() : float

Get the cost of any extra channel usage.

Returns

float

getCostsValid()

getCostsValid() : boolean

Determine if the costs provided are valid.

Returns

boolean

getRestLogFilename()

getRestLogFilename() : string

Get the name of the REST log file associated with this instance. Empty for non-REST applications.

Returns

string

getRestTo()

getRestTo() : string

Get the to parameter supplied for an outbound REST call. Empty for non-REST or inbound applications.

Returns

string

getRestFrom()

getRestFrom() : string

Get the from parameter supplied for an outbound REST call. Empty for non-REST or inbound applications.

Returns

string

getRestInitialToken()

getRestInitialToken() : string

Get a shortened representation of the token parameter initially supplied for an outbound REST call. Empty for non-REST or inbound applications.

Returns

string

getTTSCost()

getTTSCost() : float

Get the cost of TTS usage.

Returns

float

getTTSUnitCost()

getTTSUnitCost() : float

Get the cost of a second of TTS.

Returns

float

getTTSSeconds()

getTTSSeconds() : float

Get the amount of TTS used.

Returns

float

getFeatureCost()

getFeatureCost() : float

Get the cost of features used by this application instance.

Returns

float

getFeatureSeconds()

getFeatureSeconds() : float

Get the total duration of any features used in seconds.

Returns

float

getTTSNeuralSeconds()

getTTSNeuralSeconds() : float

Get the amount of neural TTS used.

Returns

float

getTTSNeuralUnitCost()

getTTSNeuralUnitCost() : float

Get the cost of a second of neural TTS.

Returns

float

getTTSNeuralCost()

getTTSNeuralCost() : float

Get the cost of neural TTS usage.

Returns

float