NotificationController
extends ApiController
in package
Class ApiBaseController.
Table of Contents
- $config : AirlayConfig
- $config : AirlayConfig
- $request : Request
- $user : UserEntity
- $status : StatusPage|null
- $tokenHandler : TokenHandler|null
- __destruct() : mixed
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- deleteByIdAction() : string
- POST Delete notification by id request([ "method" => "POST", "url" => "api/v4/notification/deleteById", 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'notification id', 'required' => true ] ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
- deleteByIdsAction() : string
- POST Delete notification by ids request([ "method" => "POST", "url" => "api/v4/notification/deleteByIds", 'params' => [ [ 'name' => 'ids', 'type' => 'objectId[]', 'description' => 'notifications ids', 'required' => true ] ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
- deleteByToolAction() : string
- POST Delete user notification by tool request([ "method" => "POST", "url" => "api/v4/notification/deleteByTool", 'params' => [ [ 'name' => 'tool', 'type' => 'string', 'description' => 'notification tool', 'required' => true ], ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
- getAction() : string
- Get notifications.
- indexAction() : mixed
- initialize() : void
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
Properties
$config
public
AirlayConfig
$config
$config
public
AirlayConfig
$config
$request
public
Request
$request
$user
public
UserEntity
$user
$status
protected
StatusPage|null
$status
$tokenHandler
protected
TokenHandler|null
$tokenHandler
Methods
__destruct()
public
__destruct() : mixed
Return values
mixed —afterExecuteRoute()
public
afterExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —beforeExecuteRoute()
public
beforeExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —deleteByIdAction()
POST Delete notification by id request([ "method" => "POST", "url" => "api/v4/notification/deleteById", 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'notification id', 'required' => true ] ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
public
deleteByIdAction() : string
Tags
Return values
string —deleteByIdsAction()
POST Delete notification by ids request([ "method" => "POST", "url" => "api/v4/notification/deleteByIds", 'params' => [ [ 'name' => 'ids', 'type' => 'objectId[]', 'description' => 'notifications ids', 'required' => true ] ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
public
deleteByIdsAction() : string
Tags
Return values
string —deleteByToolAction()
POST Delete user notification by tool request([ "method" => "POST", "url" => "api/v4/notification/deleteByTool", 'params' => [ [ 'name' => 'tool', 'type' => 'string', 'description' => 'notification tool', 'required' => true ], ] ]) response([ "status" => 200, "message" => "OK" "code" => 0 ])
public
deleteByToolAction() : string
Tags
Return values
string —getAction()
Get notifications.
public
getAction() : string
request([ 'method' => 'GET', 'url' => '/api/v4/notification/get', 'params' => [ [ 'name' => 'tool', 'type' => 'string', 'description' => 'notification tool', 'required' => false ], [ 'name' => 'type', 'type' => 'string', 'description' => 'notification type', 'required' => false ], ] ]) response([ 'status' => 'OK', 'message' => NotificationEntity[] 'code' => 0 ])
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —attachTmpFile()
protected
attachTmpFile(TmpFile $tmpFile) : Response
Parameters
- $tmpFile : TmpFile
Return values
Response —firesAnRelationUpdateEvents()
protected
firesAnRelationUpdateEvents(array<string|int, mixed> $relations, ObjectId $dataSetId[, DataSetLogEntity|null $log = null ]) : void
Parameters
- $relations : array<string|int, mixed>
- $dataSetId : ObjectId
- $log : DataSetLogEntity|null = null
Return values
void —getId()
protected
getId() : mixed
Return values
mixed —getNormalizedUserId()
protected
getNormalizedUserId() : int|ObjectId
Tags
Return values
int|ObjectId —getTranslator()
protected
getTranslator([string|null $language = null ]) : NativeArray
Parameters
- $language : string|null = null
Tags
Return values
NativeArray —getUserInfo()
protected
getUserInfo() : UserEntity
Tags
Return values
UserEntity —secureData()
protected
secureData(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —sendEmail()
protected
sendEmail(string $email, string $name, string $subject, string $body) : mixed
Parameters
- $email : string
- $name : string
- $subject : string
- $body : string