AVPush (storage core library 5.0.13 API)

java.lang.Object
- cn.leancloud.AVPush

```
public class AVPush
extends Object
```

构造器概要

构造器
构造器和说明

AVPush()
Creates a new push notification.

构造器
构造器和说明
`AVPush()` Creates a new push notification.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clearExpiration()` Clears both expiration values, indicating that the notification should never expire.
`Set<String>`	`getChannelSet()`
`long`	`getExpirationTime()`
`long`	`getExpirationTimeInterval()`
`AVObject`	`getNotification()` 返回推送后创建的_Notification对象。
`Map<String,Object>`	`getPushData()`
`Date`	`getPushDate()`
`AVQuery<? extends AVInstallation>`	`getPushQuery()`
`Set<String>`	`getPushTarget()`
`void`	`send()` Sends this push notification while blocking this thread until the push notification has successfully reached the AVOSCloud servers.
`static io.reactivex.Observable<com.alibaba.fastjson.JSONObject>`	`sendDataInBackground(com.alibaba.fastjson.JSONObject data, AVQuery<? extends AVInstallation> query)` A helper method to concisely send a push to a query.
`static void`	`sendDataInBackground(com.alibaba.fastjson.JSONObject data, AVQuery<? extends AVInstallation> query, SendCallback callback)` A helper method to concisely send a push to a query.
`io.reactivex.Observable<com.alibaba.fastjson.JSONObject>`	`sendInBackground()` Sends this push notification in a background thread.
`void`	`sendInBackground(SendCallback callback)` Sends this push notification in a background thread.
`static io.reactivex.Observable<com.alibaba.fastjson.JSONObject>`	`sendMessageInBackground(String message, AVQuery<? extends AVInstallation> query)` A helper method to concisely send a push message to a query.
`static void`	`sendMessageInBackground(String message, AVQuery<? extends AVInstallation> query, SendCallback callback)` A helper method to concisely send a push message to a query.
`void`	`setChannel(String channel)` Sets the channel on which this push notification will be sent.
`void`	`setChannels(Collection<String> channels)` Sets the collection of channels on which this push notification will be sent.
`void`	`setCloudQuery(String cql)` 可以通过 cql来针对push进行筛选请注意cql 的主体应该是_Installation表请在设置cql的同时，不要设置pushTarget(ios,android,wp)
`void`	`setData(com.alibaba.fastjson.JSONObject data)` Sets the entire data of the push message.
`void`	`setData(Map<String,Object> data)` Sets the entire data of the push message.
`void`	`setExpirationTime(long time)` Sets a UNIX epoch timestamp at which this notification should expire, in seconds (UTC).
`void`	`setExpirationTimeInterval(long timeInterval)` Sets the time interval after which this notification should expire, in seconds.
`void`	`setMessage(String message)` Sets the message that will be shown in the notification.
`void`	`setPushDate(Date date)` Set the push date at which the push will be sent.
`void`	`setPushToAndroid(boolean pushToAndroid)`
`void`	`setPushToIOS(boolean pushToIOS)`
`void`	`setPushToWindowsPhone(boolean pushToWP)`
`void`	`setQuery(AVQuery<? extends AVInstallation> query)` Sets the query for this push for which this push notification will be sent.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AVPush
```
public AVPush()
```
    Creates a new push notification. The default channel is the empty string, also known as the global broadcast channel, but this value can be overridden using AVPush.setChannel(String), AVPush.setChannels(Collection) or AVPush.setQuery(AVQuery). Before sending the push notification you must call either AVPush.setMessage(String) or AVPush.setData(JSONObject).
- 方法详细资料
  - getChannelSet
```
public Set<String> getChannelSet()
```
  - getNotification
```
public AVObject getNotification()
```
    返回推送后创建的_Notification对象。
    
    返回:
  - getPushQuery
```
public AVQuery<? extends AVInstallation> getPushQuery()
```
  - getPushDate
```
public Date getPushDate()
```
  - getExpirationTime
```
public long getExpirationTime()
```
  - getExpirationTimeInterval
```
public long getExpirationTimeInterval()
```
  - getPushTarget
```
public Set<String> getPushTarget()
```
  - getPushData
```
public Map<String,Object> getPushData()
```
  - setChannel
```
public void setChannel(String channel)
```
    Sets the channel on which this push notification will be sent. The channel name must start with a letter and contain only letters, numbers, dashes, and underscores. A push can either have channels or a query. Setting this will unset the query.
  - setChannels
```
public void setChannels(Collection<String> channels)
```
    Sets the collection of channels on which this push notification will be sent. Each channel name must start with a letter and contain only letters, numbers, dashes, and underscores. A push can either have channels or a query. Setting this will unset the query.
  - setData
```
public void setData(Map<String,Object> data)
```
    Sets the entire data of the push message. See the push guide for more details on the data format. This will overwrite any data specified in AVPush.setMessage(String).
    
    从以下版本开始:
    
    1.4.4
  - setData
```
public void setData(com.alibaba.fastjson.JSONObject data)
```
    Sets the entire data of the push message. See the push guide for more details on the data format. This will overwrite any data specified in AVPush.setMessage(String).
  - setPushDate
```
public void setPushDate(Date date)
```
    Set the push date at which the push will be sent.
    
    参数:
    
    date - The push date.
  - setExpirationTime
```
public void setExpirationTime(long time)
```
    Sets a UNIX epoch timestamp at which this notification should expire, in seconds (UTC). This notification will be sent to devices which are either online at the time the notification is sent, or which come online before the expiration time is reached. Because device clocks are not guaranteed to be accurate, most applications should instead use AVPush.setExpirationTimeInterval(long).
  - setExpirationTimeInterval
```
public void setExpirationTimeInterval(long timeInterval)
```
    Sets the time interval after which this notification should expire, in seconds. This notification will be sent to devices which are either online at the time the notification is sent, or which come online within the given number of seconds of the notification being received by AVOSCloud's server. An interval which is less than or equal to zero indicates that the message should only be sent to devices which are currently online.
  - setMessage
```
public void setMessage(String message)
```
    Sets the message that will be shown in the notification. This will overwrite any data specified in AVPush.setData(JSONObject).
  - setPushToAndroid
```
public void setPushToAndroid(boolean pushToAndroid)
```
  - setPushToIOS
```
public void setPushToIOS(boolean pushToIOS)
```
  - setPushToWindowsPhone
```
public void setPushToWindowsPhone(boolean pushToWP)
```
  - setQuery
```
public void setQuery(AVQuery<? extends AVInstallation> query)
```
    Sets the query for this push for which this push notification will be sent. This query will be executed in the AVOSCloud cloud; this push notification will be sent to Installations which this query yields. A push can either have channels or a query. Setting this will unset the channels.
    
    参数:
    
    query - A query to which this push should target. This must be a AVInstallation query.
  - setCloudQuery
```
public void setCloudQuery(String cql)
```
    可以通过 cql来针对push进行筛选请注意cql 的主体应该是_Installation表请在设置cql的同时，不要设置pushTarget(ios,android,wp)
    
    参数:
    
    cql -
    
    从以下版本开始:
    
    2.6.7
  - clearExpiration
```
public void clearExpiration()
```
    Clears both expiration values, indicating that the notification should never expire.
  - send
```
public void send()
```
    Sends this push notification while blocking this thread until the push notification has successfully reached the AVOSCloud servers. Typically, you should use AVPush.sendInBackground() instead of this, unless you are managing your own threading.
  - sendInBackground
```
public io.reactivex.Observable<com.alibaba.fastjson.JSONObject> sendInBackground()
```
    Sends this push notification in a background thread. This is preferable to using send(), unless your code is already running from a background thread.
  - sendInBackground
```
public void sendInBackground(SendCallback callback)
```
    Sends this push notification in a background thread. This is preferable to using send(), unless your code is already running from a background thread.
    
    参数:
    
    callback - callback.done(e) is called when the send completes.
  - sendDataInBackground
```
public static void sendDataInBackground(com.alibaba.fastjson.JSONObject data,
                                        AVQuery<? extends AVInstallation> query,
                                        SendCallback callback)
```
    A helper method to concisely send a push to a query. This method is equivalent to
```
 AVPush push = new AVPush();
 push.setData(data);
 push.setQuery(query);
 push.sendInBackground(callback);
 
```
    参数:
    
    data - The entire data of the push message. See the push guide for more details on the data format.
    
    query - A AVInstallation query which specifies the recipients of a push.
    
    callback - callback.done(e) is called when the send completes.
  - sendDataInBackground
```
public static io.reactivex.Observable<com.alibaba.fastjson.JSONObject> sendDataInBackground(com.alibaba.fastjson.JSONObject data,
                                                                                            AVQuery<? extends AVInstallation> query)
```
    A helper method to concisely send a push to a query. This method is equivalent to
```
 AVPush push = new AVPush();
 push.setData(data);
 push.setQuery(query);
 push.sendInBackground(callback);
 
```
    参数:
    
    data - The entire data of the push message. See the push guide for more details on the data format.
    
    query - A AVInstallation query which specifies the recipients of a push.
  - sendMessageInBackground
```
public static io.reactivex.Observable<com.alibaba.fastjson.JSONObject> sendMessageInBackground(String message,
                                                                                               AVQuery<? extends AVInstallation> query)
```
    A helper method to concisely send a push message to a query. This method is equivalent to
```
 AVPush push = new AVPush();
 push.setMessage(message);
 push.setQuery(query);
 push.sendInBackground();
 
```
    参数:
    
    message - The message that will be shown in the notification.
    
    query - A AVInstallation query which specifies the recipients of a push.
  - sendMessageInBackground
```
public static void sendMessageInBackground(String message,
                                           AVQuery<? extends AVInstallation> query,
                                           SendCallback callback)
```
    A helper method to concisely send a push message to a query. This method is equivalent to
```
 AVPush push = new AVPush();
 push.setMessage(message);
 push.setQuery(query);
 push.sendInBackground(callback);
 
```
    参数:
    
    message - The message that will be shown in the notification.
    
    query - A AVInstallation query which specifies the recipients of a push.
    
    callback - callback.done(e) is called when the send completes.

类 AVPush

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AVPush

方法详细资料

getChannelSet

getNotification

getPushQuery

getPushDate

getExpirationTime

getExpirationTimeInterval

getPushTarget

getPushData

setChannel

setChannels

setData

setData

setPushDate

setExpirationTime

setExpirationTimeInterval

setMessage

setPushToAndroid

setPushToIOS

setPushToWindowsPhone

setQuery

setCloudQuery

clearExpiration

send

sendInBackground

sendInBackground

sendDataInBackground

sendDataInBackground

sendMessageInBackground

sendMessageInBackground