inc\classes\Message.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Messages APIs

Manipulating with Messages objects

Author
Sergey Dilong  
License
GPL-2.0  
Package
Temply-Account\Objects  

\Message

Package: Temply-Account\Objects
Messages Object

Sending, getting, modifying, etc.

Author
Sergey Dilong  
License
GPL-2.0  

Properties

>VPropertyprivatearray $data = array()

stored Message info

Default valuearray()Details
Type
array

Methods

methodprivateInitById(integer $a, array $o = array()) : void

Init Message

Get message data by ID

Parameters
NameTypeDescription
$ainteger

Message ID

$oarray

Options

  • ACCESS_KEY [string] - Access key to get a message
  • CHAT_CLASS [bool] - Get message chat as Chat object
Throws
ExceptionDescription
\apiException* [401] Incorrect try to access * [501] Incorrect message access key * [502] Access key refs not to a message
Details
Api
 
See
Call this method outside the class  
methodpublic__construct(array | integer $a, array $o = array()) : void

Construct

Create new Message object

Parameters
NameTypeDescription
$aarray | integer

@a Query

  • array - new message data
  • integer - get a message
$oarray

Options

Throws
ExceptionDescription
\apiException* [400] Incorrect input data * [401] Incorrect try to access * [501] Incorrect message access key * [502] Access key refs not to a message
methodpublicget() : boolean | array

Get Message data

All requested info about message

Returns
TypeDescription
boolean | arrayIf === `false` - request failed
Details
Api
 
Documentation was generated by phpDocumentor v2.9.0.