• 홈
• Prowl
• Message

PHP 클래스 Prowl\Message

This class represents a single message to be send by the connector. 파일 보기 프로젝트 열기: xenji/prowlphp 1 사용 예제들

공개 메소드들

메소드	설명
addApiKey ( string $sKey ) : Message	Sets the api key.
getApiKeysAsArray ( ) : array[string]	Returns all actual api keys as array.
getApiKeysAsString ( ) : string	Returns all actual api keys as string
getApplication ( ) : string	Returns the application string.
getDescription ( ) : string	Returns the description.
getEvent ( ) : string	Returns the event.
getFilter ( ) : Prowl\Security\Secureable	Returns the filter instance, if set. It might return null when no filter is set.
getFilterCallback ( ) : Closure	Getter for the filter closure.
getPriority ( ) : integer	Returns the priority as signed integer
getUrl ( ) : string	Returns the Url that should be sent with the message
removeApiKey ( string $sKey ) : Message	Removes an api key from the receiver list.
setApplication ( string $sApp ) : Message	Sets the application.
setDescription ( string $sDescription ) : Message	Sets the event description.
setEvent ( string $sEvent ) : Message	Sets the event.
setFilter ( Prowl\Security\Secureable $oFilterInstance ) : Message	Set a filter instance. If you do not need a filter, use the Passthrough filter.
setFilterCallback ( Closure $cCallback ) : void	An alternative way to filter. You can set a closure instead of a filter instance. If both are set, the closure will be preferred.
setPriority ( integer $iPriority ) : Message	Sets the proirity (-2 to 2) This method uses a fluent interface.
setUrl ( string $sUrl ) : void	Sets an Url to be sent with the message.
validate ( ) : boolean	Validates the basic needs of the prowl api.

메소드 상세