ILIAS\Notifications\Provider\NotificationsPushProvider Class Reference

Collaboration diagram for ILIAS\Notifications\Provider\NotificationsPushProvider:

Public Member Functions
	__construct (PushProviderInterface $provider)
	push (ilObjUser $user, string $title, string $description='', ?ilNotificationLink $link=null)

Protected Attributes
const int	TTL = 60
ilNotificationPushHandler	$handler
ilNotificationConfig	$config

Detailed Description

Definition at line 32 of file NotificationsPushProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Notifications\Provider\NotificationsPushProvider::__construct ( PushProviderInterface  $provider )

final

Definition at line 38 of file NotificationsPushProvider.php.

    {
        $this->handler = new ilNotificationPushHandler($provider);
        $this->config = new ilNotificationConfig('push');
        $this->config->setHandlerParam('setting.user_pref', $provider->getIdentifier());
        $this->config->setHandlerParam('setting.ttl', (string) $this::TTL);
    }

References $provider.

Member Function Documentation

push()

ILIAS\Notifications\Provider\NotificationsPushProvider::push	(	ilObjUser	$user,
		string	$title,
		string	$description = '',
		?ilNotificationLink	$link = null
	)

Definition at line 46 of file NotificationsPushProvider.php.

                                                                                                                    : bool
    {
        $notification = new ilNotificationObject($this->config, $user);
        $notification->title = $title;
        $notification->shortDescription = $description;
        $notification->links = $link ? [$link] : [];
        $this->handler->notify($notification);
        return $this->handler->getLastQueueResult() === PushQueueResult::SUCCEEDED;
    }

References ILIAS\Notifications\Model\Push\SUCCEEDED.

Field Documentation

$config

ilNotificationConfig ILIAS\Notifications\Provider\NotificationsPushProvider::$config

protected

Definition at line 36 of file NotificationsPushProvider.php.

$handler

ilNotificationPushHandler ILIAS\Notifications\Provider\NotificationsPushProvider::$handler

protected

Definition at line 35 of file NotificationsPushProvider.php.

TTL

const int ILIAS\Notifications\Provider\NotificationsPushProvider::TTL = 60

protected

Definition at line 34 of file NotificationsPushProvider.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Notifications/classes/Provider/NotificationsPushProvider.php