\EasyWeChat\Kernel\MessagesDeviceEvent

Class DeviceEvent.

Summary

Methods

Properties

Constants

__construct()
getType()
setType()
__get()
__set()
transformForJsonRequestWithoutType()
transformForJsonRequest()
transformToXml()
toXmlArray()
setAttributes()
setAttribute()
getAttribute()
isRequired()
getRequired()
with()
set()
get()
has()
merge()
only()
all()
__call()
__isset()

$media_id

TEXT
IMAGE
VOICE
VIDEO
SHORT_VIDEO
LOCATION
LINK
DEVICE_EVENT
DEVICE_TEXT
FILE
TEXT_CARD
TRANSFER
EVENT
MINIPROGRAM_PAGE
ALL

propertiesToArray()
checkRequiredAttributes()

$type
$id
$to
$from
$properties
$jsonAliases
$attributes
$snakeable

N/A

No private methods found

No private properties found

N/A

File: Kernel/Messages/DeviceEvent.php
Package: Default
Class hierarchy: \EasyWeChat\Kernel\Messages\Message

\EasyWeChat\Kernel\Messages\DeviceEvent

Constants

TEXT

TEXT = 2

IMAGE

IMAGE = 4

VOICE

VOICE = 8

VIDEO

VIDEO = 16

SHORT_VIDEO

SHORT_VIDEO = 32

LOCATION

LOCATION = 64

LINK

LINK = 128

DEVICE_EVENT

DEVICE_EVENT = 256

DEVICE_TEXT

DEVICE_TEXT = 512

FILE

FILE = 1024

TEXT_CARD

TEXT_CARD = 2048

TRANSFER

TRANSFER = 4096

EVENT

EVENT = 1048576

MINIPROGRAM_PAGE

MINIPROGRAM_PAGE = 2097152

ALL

ALL = 1049598

Properties

$media_id

$media_id : string

Type

string

$type

$type : string

Messages type.

Type

string

$id

$id : integer

Type

integer

$to

$to : string

Type

string

$from

$from : string

Type

string

$properties

$properties : array

Properties.

Type

array

$jsonAliases

$jsonAliases : array

Type

array

$attributes

$attributes : array

Type

array

$snakeable

$snakeable : boolean

Type

boolean

Methods

__construct()

__construct(array  $attributes = array())

Message constructor.

Parameters

array

$attributes

getType()

getType() : string

Return type name message.

Returns

string

setType()

setType(string  $type)

Parameters

string

$type

__get()

__get(string  $property) : mixed

Magic get.

Parameters

string

$property

Returns

mixed

__set()

__set(string  $property, mixed  $value) : $this

Magic set.

Parameters

string	$property
mixed	$value

Returns

$this

transformForJsonRequestWithoutType()

transformForJsonRequestWithoutType(array  $appends = array()) : array

Parameters

array

$appends

Returns

array

transformForJsonRequest()

transformForJsonRequest(array  $appends = array(), boolean  $withType = true) : array

Parameters

array	$appends
boolean	$withType

Returns

array

transformToXml()

transformToXml(array  $appends = array(), boolean  $returnAsArray = false) : string

Parameters

array	$appends
boolean	$returnAsArray

Returns

string

toXmlArray()

toXmlArray()

setAttributes()

setAttributes(array  $attributes = array()) : $this

Set Attributes.

Parameters

array

$attributes

Returns

$this

setAttribute()

setAttribute(string  $attribute, string  $value) : $this

Set attribute.

Parameters

string	$attribute
string	$value

Returns

$this

getAttribute()

getAttribute(string  $attribute, mixed  $default = null) : mixed

Get attribute.

Parameters

string	$attribute
mixed	$default

Returns

mixed

isRequired()

isRequired(string  $attribute) : boolean

Parameters

string

$attribute

Returns

boolean

getRequired()

getRequired() : array|mixed

Returns

array|mixed

with()

with(string  $attribute, mixed  $value) : $this

Set attribute.

Parameters

string	$attribute
mixed	$value

Returns

$this

set()

set(string  $attribute, mixed  $value) : $this

Override parent set() method.

Parameters

string	$attribute
mixed	$value

Returns

$this

get()

get(string  $attribute, mixed  $default = null) : mixed

Override parent get() method.

Parameters

string	$attribute
mixed	$default

Returns

mixed

has()

has(string  $key) : boolean

Parameters

string

$key

Returns

boolean

merge()

merge(array  $attributes) : $this

Parameters

array

$attributes

Returns

$this

only()

only(array|string  $keys) : array

Parameters

array|string

$keys

Returns

array

all()

all() : array

Return all items.

Returns

array

__call()

__call(string  $method, array  $args) : $this

Magic call.

Parameters

string	$method
array	$args

Returns

$this

__isset()

__isset(string  $key) : boolean

Whether or not an data exists by key.

Parameters

string

$key

Returns

boolean

propertiesToArray()

propertiesToArray(array  $data, array  $aliases = array()) : array|mixed

Parameters

array	$data
array	$aliases

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

array|mixed

checkRequiredAttributes()

checkRequiredAttributes()

Check required attributes.

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

<?php

/*
 * This file is part of the overtrue/wechat.
 *
 * (c) overtrue <i@overtrue.me>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace EasyWeChat\Kernel\Messages;

/**
 * Class DeviceEvent.
 *
 * @property string $media_id
 */
class DeviceEvent extends Message
{
    /**
     * Messages type.
     *
     * @var string
     */
    protected $type = 'device_event';

    /**
     * Properties.
     *
     * @var array
     */
    protected $properties = [
        'device_type',
        'device_id',
        'content',
        'session_id',
        'open_id',
    ];
}