Plentymarkets interface documentation

Notifications

Contracts

NotificationsRepositoryContract

Plugin Notifications Service

Namespace

Plenty\Modules\Notifications\Contracts

Methods
public addNotification($notificationBuiltWithNotificationBuilder):array

Add a Notification in the system

Parameters

Name

Type

Description

$notificationBuiltWithNotificationBuilder

array

An array built with NotificationBuilder::build() method

 
public fetchNotifications($queryBuiltWithNotificationsQueryBuilder, $page, $itemsPerPage):Plenty\Repositories\Models\UnspecifiedLengthPaginationResponse
Return type: UnspecifiedLengthPaginationResponse

Fetch a list of short/incomplete notifications, containing only the subject. To be used for listing purposes.

Parameters

Name

Type

Description

$queryBuiltWithNotificationsQueryBuilder

array

An array built with NotificationsQueryBuilder::build() method

$page

int

The page number, starting from 1

$itemsPerPage

int

The number of notifications per page

 
public fetchNotificationsDetails($notificationsFetchDetailsQuery):array

Fetch all the details of a Notification based on its id.

Parameters

Name

Type

Description

$notificationsFetchDetailsQuery

array

An array built with NotificationsFetchDetailsQueryBuilder::build() method

 
public acknowledgeNotifications($queryBuiltWithNotificationsAcknowledgeQueryBuilder):bool

Mark a Notification as acknowledged.

Parameters

Name

Type

Description

$queryBuiltWithNotificationsAcknowledgeQueryBuilder

array

An array built with NotificationsAcknowledgeQueryBuilder::build() method

 
public getNotificationsCount($queryBuiltWithNotificationsQueryBuilder):int

Retrieve the current unread Notifications count

Parameters

Name

Type

Description

$queryBuiltWithNotificationsQueryBuilder

array

An array built with NotificationsQueryBuilder::build() method

Models

Notification

The Notification Model

Namespace

Plenty\Modules\Notifications\Models

Methods
public toArray()

Returns this model as an array.

NotificationContent

The Notification Content model

Namespace

Plenty\Modules\Notifications\Models

Methods
public toArray()

Returns this model as an array.

NotificationUISettings

The Notification user interface settings

Namespace

Plenty\Modules\Notifications\Models

Methods
public toArray()

Returns this model as an array.