Reamaze PHP SDK
Back to top  

CreateParams

Extends \mixisLv\Reamaze\Params\BaseParams

Class CreateParams

package

mixisLv\Reamaze\Params\Messages
see

Methods

BaseParams constructor.

__construct(array $params = array())
inherited
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$params

array

__get

__get( $property) : mixed
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$property

Response

mixed

__set

__set( $property,  $value)
inherited
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$property

$value

paramsArray

paramsArray() : array
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Response

array

sanitizePage

sanitizePage( $value) : integer
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$value

Response

integer

toArray

toArray()
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Properties

message body

body : string
var

message body

Type(s)

string

Pass in additional participants in the conversation. These participants will be automatically added as recipients in future correspondences within the thread.

recipients : array
var

(optional) list of additional participants in the conversation

Type(s)

array

array['user'] [name] string conversation author name [email] string conversation author email

user : array
var

conversation author (See above)

Type(s)

array

The visibility value can be the following values: 0 (Regular) or 1 (Internal Note).

visibility : integer
var

message visibility

Type(s)

integer

(optional) true to prevent Reamaze from sending any email (or integration) notifications related to this message

suppressNotification : boolean
var

(optional) true to prevent Reamaze from sending any email (or integration) notifications related to this message

Type(s)

boolean

(optional) true to prevent Reamaze from marking the conversation as resolved when message[user] is a staff user.

suppressAutoresolve : boolean
var

(optional) true to prevent Reamaze from marking the conversation as resolved when message[user] is a staff user.

Type(s)

boolean

(optional) You can optionally pass in an attachment string attribute with a URL to attach a file to the message. The URL should specify a valid location where Reamaze can fetch the file.

attachment : string
var

(optional) You can optionally pass in an attachment string attribute with a URL to attach a file to the message. The URL should specify a valid location where Reamaze can fetch the file.

Type(s)

string