TimeTrex API Manual

TimeTrexSoapClient
in package

Table of Contents

$soap_client_obj  : mixed
__construct()  : mixed
TimeTrexSoapClient constructor.
convertDocument()  : null
getCurrencyExchangeRates()  : array<string|int, mixed>|bool
getCurrencyExchangeRatesByDate()  : bool|array<string|int, mixed>
getGeoCodeByAddress()  : null
getGeoIPData()  : null
getLocalRegistrationKey()  : bool
getPrimaryCompanyData()  : array<string|int, mixed>|bool
getRegistrationKey()  : mixed
getSoapObject()  : null|TTSoapClient
getUpgradeFileURL()  : bool
isLatestVersion()  : bool
isNewVersionReadyForUpgrade()  : bool
isUpdateNotifyEnabled()  : bool
isValidRegistrationKey()  : bool
parseResume()  : null
ping()  : mixed
printSoapDebug()  : mixed
saveRegistrationKey()  : bool
sendCompanyData()  : bool
sendCompanyUserCountData()  : bool
sendCompanyUserLocationData()  : bool
sendCompanyVersionData()  : bool
sendEmail()  : bool
sendNotification()  : bool
sendUserFeedback()  : null
syncNotifications()  : mixed
validateEmail()  : bool

Properties

Methods

convertDocument()

public convertDocument( $data[, string $format = 'pdf' ]) : null
Parameters
$data :
$format : string = 'pdf'
Return values
null

getCurrencyExchangeRates()

public getCurrencyExchangeRates(string $company_id,  $currency_arr,  $base_currency) : array<string|int, mixed>|bool
Parameters
$company_id : string

UUID

$currency_arr :
$base_currency :
Return values
array<string|int, mixed>|bool

getCurrencyExchangeRatesByDate()

public getCurrencyExchangeRatesByDate(string $company_id,  $currency_arr,  $base_currency[, int $start_date = null ][, int $end_date = null ]) : bool|array<string|int, mixed>
Parameters
$company_id : string

UUID

$currency_arr :
$base_currency :
$start_date : int = null

EPOCH

$end_date : int = null

EPOCH

Return values
bool|array<string|int, mixed>

getGeoCodeByAddress()

public getGeoCodeByAddress( $address1,  $address2,  $city,  $province,  $country,  $postal_code) : null
Parameters
$address1 :
$address2 :
$city :
$province :
$country :
$postal_code :
Return values
null

getGeoIPData()

public getGeoIPData( $ip_address) : null
Parameters
$ip_address :
Return values
null

getPrimaryCompanyData()

public getPrimaryCompanyData() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getUpgradeFileURL()

public getUpgradeFileURL([bool $force = false ]) : bool
Parameters
$force : bool = false
Return values
bool

isLatestVersion()

public isLatestVersion(string $company_id) : bool
Parameters
$company_id : string

UUID

Return values
bool

isNewVersionReadyForUpgrade()

public isNewVersionReadyForUpgrade([bool $force = false ]) : bool
Parameters
$force : bool = false
Return values
bool

isValidRegistrationKey()

public isValidRegistrationKey( $key) : bool
Parameters
$key :
Return values
bool

parseResume()

public parseResume( $resume_data,  $file_name) : null
Parameters
$resume_data :
$file_name :
Return values
null

ping()

public ping([mixed $ping_key = null ]) : mixed
Parameters
$ping_key : mixed = null
Return values
mixed

sendCompanyData()

public sendCompanyData(string $company_id[, bool $force = false ]) : bool
Parameters
$company_id : string

UUID

$force : bool = false
Return values
bool

sendCompanyUserCountData()

public sendCompanyUserCountData(string $company_id) : bool
Parameters
$company_id : string

UUID

Return values
bool

sendCompanyUserLocationData()

public sendCompanyUserLocationData(string $company_id) : bool
Parameters
$company_id : string

UUID

Return values
bool

sendCompanyVersionData()

public sendCompanyVersionData(string $company_id) : bool
Parameters
$company_id : string

UUID

Return values
bool

sendEmail()

public sendEmail( $to,  $headers,  $body) : bool
Parameters
$to :
$headers :
$body :
Return values
bool

sendNotification()

public sendNotification( $device_tokens,  $title,  $body[, null $payload_data = null ], int $ttl[, string $priority = 'normal' ][, bool $force = false ]) : bool
Parameters
$device_tokens :
$title :
$body :
$payload_data : null = null
$ttl : int
$priority : string = 'normal'
$force : bool = false
Return values
bool

sendUserFeedback()

public sendUserFeedback( $rating,  $message, object $u_obj) : null
Parameters
$rating :
$message :
$u_obj : object
Return values
null

syncNotifications()

public syncNotifications(mixed $last_check_epoch[, mixed $force = false ]) : mixed
Parameters
$last_check_epoch : mixed
$force : mixed = false
Return values
mixed

Search results