AVPush (java-sdk 0.1.7 API)

java.lang.Object
- com.avos.avoscloud.AVPush

```
public class AVPush
extends Object
```
The AVPush is a local representation of data that can be sent as a push notification.

The typical workflow for sending a push notification from the client is to construct a new AVPush, use the setter functions to fill it with data, and then use AVPush.sendInBackground() to send it.

Constructor Summary

Constructors
Constructor and Description

AVPush()
Creates a new push notification.

Constructors
Constructor and Description
`AVPush()` Creates a new push notification.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearExpiration()` Clears both expiration values, indicating that the notification should never expire.
`Set<String>`	`getChannelSet()`
`long`	`getExpirationTime()`
`long`	`getExpirationTimeInterval()`
`com.avos.avoscloud.AVObject`	`getNotification()` 返回推送后创建的_Notification对象。
`boolean`	`getProductionMode()`
`Map<String,Object>`	`getPushData()`
`Date`	`getPushDate()`
`com.avos.avoscloud.AVQuery`	`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 void`	`sendDataInBackground(org.json.JSONObject data, com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query, com.avos.avoscloud.SendCallback callback)` A helper method to concisely send a push to a query.
`void`	`sendInBackground()` Sends this push notification in a background thread.
`void`	`sendInBackground(com.avos.avoscloud.SendCallback callback)` Sends this push notification in a background thread.
`static void`	`sendMessageInBackground(String message, com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query)` A helper method to concisely send a push message to a query.
`static void`	`sendMessageInBackground(String message, com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query, com.avos.avoscloud.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(org.json.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`	`setProductionMode(boolean production)` 设定iOS推送是否是生产环境
`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(com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query)` Sets the query for this push for which this push notification will be sent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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).
- Method Detail
  - getChannelSet
```
public Set<String> getChannelSet()
```
  - getNotification
```
public com.avos.avoscloud.AVObject getNotification()
```
    返回推送后创建的_Notification对象。
    
    Returns:
    
    _Notification对象
  - getPushQuery
```
public com.avos.avoscloud.AVQuery getPushQuery()
```
  - getPushDate
```
public Date getPushDate()
```
  - getExpirationTime
```
public long getExpirationTime()
```
  - getExpirationTimeInterval
```
public long getExpirationTimeInterval()
```
  - getPushTarget
```
public Set<String> getPushTarget()
```
  - getPushData
```
public Map<String,Object> getPushData()
```
  - 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.
  - sendDataInBackground
```
public static void sendDataInBackground(org.json.JSONObject data,
                                        com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query,
                                        com.avos.avoscloud.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);
 
```
    Parameters:
    
    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.
  - sendInBackground
```
public void 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(com.avos.avoscloud.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.
    
    Parameters:
    
    callback - callback.done(e) is called when the send completes.
  - sendMessageInBackground
```
public static void sendMessageInBackground(String message,
                                           com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> 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();
 
```
    Parameters:
    
    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,
                                           com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> query,
                                           com.avos.avoscloud.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);
 
```
    Parameters:
    
    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.
  - 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.
    
    Parameters:
    
    channel - set push channel
  - 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.
    
    Parameters:
    
    channels - set push channels
  - 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).
    
    Parameters:
    
    data - push data
  - setData
```
public void setData(org.json.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).
    
    Parameters:
    
    data - push data
  - setPushDate
```
public void setPushDate(Date date)
```
    Set the push date at which the push will be sent.
    
    Parameters:
    
    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).
    
    Parameters:
    
    time - expire date
  - 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.
    
    Parameters:
    
    timeInterval - expirationTimeInterval
  - 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).
    
    Parameters:
    
    message - set push message
  - setPushToAndroid
```
public void setPushToAndroid(boolean pushToAndroid)
```
  - setPushToIOS
```
public void setPushToIOS(boolean pushToIOS)
```
  - setPushToWindowsPhone
```
public void setPushToWindowsPhone(boolean pushToWP)
```
  - setQuery
```
public void setQuery(com.avos.avoscloud.AVQuery<? extends com.avos.avoscloud.AVObject> 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.
    
    Parameters:
    
    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)
    
    Parameters:
    
    cql - cql for push
    
    Since:
    
    2.6.7
  - getProductionMode
```
public boolean getProductionMode()
```
  - setProductionMode
```
public void setProductionMode(boolean production)
```
    设定iOS推送是否是生产环境
    
    Parameters:
    
    production,true为生产环境，默认是true -
    
    Since:
    
    2.6.9

Class AVPush

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AVPush

Method Detail

getChannelSet

getNotification

getPushQuery

getPushDate

getExpirationTime

getExpirationTimeInterval

getPushTarget

getPushData

clearExpiration

send

sendDataInBackground

sendInBackground

sendInBackground

sendMessageInBackground

sendMessageInBackground

setChannel

setChannels

setData

setData

setPushDate

setExpirationTime

setExpirationTimeInterval

setMessage

setPushToAndroid

setPushToIOS

setPushToWindowsPhone

setQuery

setCloudQuery

getProductionMode

setProductionMode