TimeTrex API Manual

Notification
in package

Table of Contents

deletePendingNotifications()  : bool
getNextDecentEffectiveDate()  : false|int
Finds the next weekday at 12PM noon to make the notification effective date.
sendNotification()  : bool
sendNotificationToAllUsers()  : mixed
syncNotifications()  : bool

Methods

deletePendingNotifications()

public static deletePendingNotifications( $type_id[,  $user_ids = null ][, null $object_id = null ][, null $epoch = null ]) : bool
Parameters
$type_id :
$user_ids : = null
$object_id : null = null
$epoch : null = null
Return values
bool —

getNextDecentEffectiveDate()

Finds the next weekday at 12PM noon to make the notification effective date.

public static getNextDecentEffectiveDate([ $epoch = null ]) : false|int

This is useful for maintenance jobs that run in the middle of the night or on weekends that send notifications, so users aren't getting woken up for things like "New Version" notices.

Parameters
$epoch : = null
Return values
false|int —

sendNotification()

public static sendNotification( $data_array, int $created_before_timestamp) : bool
Parameters
$data_array :
$created_before_timestamp : int
Return values
bool —

sendNotificationToAllUsers()

public static sendNotificationToAllUsers( $minimum_permission_level,  $per_user_check_function,  $per_company_check_function,  $notification_data,  $minimum_time_between_duplicates[, null $company_id = null ][, mixed $append_email_footer = true ]) : mixed
Parameters
$minimum_permission_level :
$per_user_check_function :
$per_company_check_function :
$notification_data :
$minimum_time_between_duplicates :
$company_id : null = null
$append_email_footer : mixed = true
Return values
mixed —

syncNotifications()

public static syncNotifications( $last_check_epoch) : bool
Parameters
$last_check_epoch :
Return values
bool —

Search results