update device api example

Author: xiezefan

examples/DeviceExample.php

@@ -52,6 +52,7 @@ function printAPIConnectionErrorStack($e) {
 
 /*----Devices Example----*/
 try {
+    //获取当前用户的所有属性，包含tags, alias。
     $result = $client->getDeviceTagAlias($REGISTRATION_ID1);
     $payload = $result->body;
     echo '<b>getDeviceTagAlias</b>' . $br;
@@ -65,6 +66,7 @@ function printAPIConnectionErrorStack($e) {
 }
 
 try {
+    //移除指定RegistrationId的所有alias
     $result = $client->removeDeviceAlias($REGISTRATION_ID1);
     echo '<b>removeDeviceAlias</b>' . $br;
     if ($result->isOk) {
@@ -81,6 +83,7 @@ function printAPIConnectionErrorStack($e) {
 
 
 try {
+    //移除指定RegistrationId的所有tag
     $result = $client->removeDeviceTag($REGISTRATION_ID1);
     echo '<b>removeDeviceTag</b>' . $br;
     if ($result->isOk) {
@@ -97,6 +100,7 @@ function printAPIConnectionErrorStack($e) {
 
 
 try {
+    //更新指定RegistrationId的指定属性，当前支持tags, alias
     $result = $client->updateDeviceTagAlias($REGISTRATION_ID1, $ALIAS1, array($TAG1, $TAG2), array($TAG3));
     echo '<b>updateTagDevices</b>' . $br;
     if ($result->isOk) {
@@ -114,6 +118,7 @@ function printAPIConnectionErrorStack($e) {
 
 /*----Tags Example----*/
 try {
+    //获取当前应用的所有标签列表
     $result = $client->getTags();
     $payload = $result->body;
     echo '<b>getTags</b>' . $br;
@@ -126,6 +131,7 @@ function printAPIConnectionErrorStack($e) {
 }
 
 try {
+    //查询某个用户是否在tag下
     $result = $client->isDeviceInTag($REGISTRATION_ID1, $TAG1);
     $payload = $result->body;
     echo '<b>isDeviceInTag</b>' . $br;
@@ -138,6 +144,7 @@ function printAPIConnectionErrorStack($e) {
 }
 
 try {
+    //对指定tag添加或者删除registrationId
     $result = $client->updateTagDevices($TAG1, array($REGISTRATION_ID1), array($REGISTRATION_ID2));
     echo '<b>updateTagDevices</b>' . $br;
     if ($result->isOk) {
@@ -153,6 +160,7 @@ function printAPIConnectionErrorStack($e) {
 }
 
 try {
+    //删除指定Tag，以及与其关联的用户之间的关联关系
     $result = $client->deleteTag($TAG2);
     echo '<b>deleteTag</b>' . $br;
     if ($result->isOk) {
@@ -169,6 +177,7 @@ function printAPIConnectionErrorStack($e) {
 
 /*----Alias Example----*/
 try {
+    //删除指定alias，以及该alias与用户的绑定关系
     $result = $client->getAliasDevices($ALIAS1, array('ios', 'android'));
     $payload = $result->body;
     echo '<b>getAliasDevices</b>' . $br;

src/JPush/JPushClient.php

@@ -88,9 +88,9 @@ public function users($time_unit, $start, $duration) {
 
     /*----Device API start----*/
     /**
-     * 获取当前用户的所有属性，包含tags, alias。
+     * 获取指定RegistrationId的所有属性，包含tags, alias。
      * @param $registrationId
-     * @return \Httpful\associative|null|string
+     * @return DeviceResponse
      */
     public function getDeviceTagAlias($registrationId) {
         $header = array('User-Agent' => self::USER_AGENT,
@@ -102,7 +102,12 @@ public function getDeviceTagAlias($registrationId) {
         return new DeviceResponse($response);
     }
 
-
+    /**
+     * 移除指定RegistrationId的所有tag
+     * @param $registrationId
+     * @return DeviceResponse
+     * @throws \InvalidArgumentException
+     */
     public function removeDeviceTag($registrationId) {
         if (is_null($registrationId) || !is_string($registrationId)) {
             throw new InvalidArgumentException("Invalid registrationId string");
@@ -117,6 +122,12 @@ public function removeDeviceTag($registrationId) {
         return new DeviceResponse($response);
     }
 
+    /**
+     * 移除指定RegistrationId的所有alias
+     * @param $registrationId
+     * @return DeviceResponse
+     * @throws \InvalidArgumentException
+     */
     public function removeDeviceAlias($registrationId) {
         if (is_null($registrationId) || !is_string($registrationId)) {
             throw new InvalidArgumentException("Invalid registrationId string");
@@ -132,12 +143,12 @@ public function removeDeviceAlias($registrationId) {
     }
 
     /**
-     * 更新当前用户的指定属性，当前支持tags, alias
+     * 更新指定RegistrationId的指定属性，当前支持tags, alias
      * @param $registrationId
-     * @param $alias
-     * @param $addTags
-     * @param $removeTags
-     * @return \Httpful\associative|null|string
+     * @param null $alias
+     * @param null $addTags
+     * @param null $removeTags
+     * @return DeviceResponse
      * @throws \InvalidArgumentException
      */
     public function updateDeviceTagAlias($registrationId, $alias = null, $addTags = null, $removeTags = null) {
@@ -196,7 +207,7 @@ public function updateDeviceTagAlias($registrationId, $alias = null, $addTags =
 
     /**
      * 获取当前应用的所有标签列表
-     * @return \Httpful\associative|null|string
+     * @return DeviceResponse
      */
     public function getTags() {
         $header = array('User-Agent' => self::USER_AGENT,
@@ -211,7 +222,7 @@ public function getTags() {
      * 查询某个用户是否在tag下
      * @param $registrationId
      * @param $tag
-     * @return \Httpful\associative|null|string
+     * @return DeviceResponse
      * @throws \InvalidArgumentException
      */
     public function isDeviceInTag($registrationId, $tag) {
@@ -235,7 +246,7 @@ public function isDeviceInTag($registrationId, $tag) {
     }
 
     /**
-     * 为一个标签添加或者删除用户
+     * 对指定tag添加或者删除registrationId
      * @param $tag
      * @param null $addDevices
      * @param null $removeDevices
@@ -283,8 +294,10 @@ public function updateTagDevices($tag, $addDevices = null, $removeDevices = null
     }
 
     /**
-     * 删除一个标签，以及标签与用户之间的关联关系
+     * 删除指定Tag，以及与其关联的用户之间的关联关系
      * @param $tag
+     * @return DeviceResponse
+     * @throws \InvalidArgumentException
      */
     public function deleteTag($tag) {
         if (is_null($tag) || !is_string($tag)) {
@@ -304,7 +317,7 @@ public function deleteTag($tag) {
      * 获取指定alias下的用户，最多输出10个
      * @param $alias
      * @param null $platform
-     * @return \Httpful\associative|null|string
+     * @return DeviceResponse
      * @throws \InvalidArgumentException
      */
     public function getAliasDevices($alias, $platform = null) {
@@ -339,9 +352,9 @@ public function getAliasDevices($alias, $platform = null) {
     }
 
     /**
-     * 删除一个别名，以及该别名与用户的绑定关系
+     * 删除指定alias，以及该alias与用户的绑定关系
      * @param $alias
-     * @return \Httpful\associative|null|string
+     * @return DeviceResponse
      * @throws \InvalidArgumentException
      */
     public function deleteAlias($alias) {