LCPush (leancloud sdk 8.2.28 API)

java.lang.Object
- cn.leancloud.LCPush

```
public class LCPush
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static String iOSEnvironmentDev

static String iOSEnvironmentProd

Fields
Modifier and Type	Field and Description
`static String`	`iOSEnvironmentDev`
`static String`	`iOSEnvironmentProd`

Constructor Summary

Constructors
Constructor and Description

LCPush()
Creates a new push notification.

Constructors
Constructor and Description
`LCPush()` 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()` Return channel set.
`long`	`getExpirationTime()` Get expiration time.
`long`	`getExpirationTimeInterval()` Get expiration time interval.
`int`	`getFlowControl()` Get push flow control value.
`LCObject`	`getNotification()` Return the instance of _Notification。
`Map<String,Object>`	`getPushData()` Get push data.
`Date`	`getPushDate()` Get push date.
`LCQuery<? extends LCInstallation>`	`getPushQuery()` Return push query instance.
`Set<String>`	`getPushTarget()` Get push target.
`void`	`send()` Sends this push notification while blocking this thread until the push notification has successfully reached the AVOSCloud servers.
`static io.reactivex.Observable<JSONObject>`	`sendDataInBackground(JSONObject data, LCQuery<? extends LCInstallation> query)` A helper method to concisely send a push to a query.
`static void`	`sendDataInBackground(JSONObject data, LCQuery<? extends LCInstallation> query, SendCallback callback)` A helper method to concisely send a push to a query.
`io.reactivex.Observable<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<JSONObject>`	`sendMessageInBackground(String message, LCQuery<? extends LCInstallation> query)` A helper method to concisely send a push message to a query.
`static void`	`sendMessageInBackground(String message, LCQuery<? extends LCInstallation> query, SendCallback callback)` A helper method to concisely send a push message to a query.
`void`	`setAPNsTeamId(String APNsTeamId)` set APNs Team Id(optinal, only used by Token Authentication)
`void`	`setAPNsTopic(String APNsTopic)` set APNs Topic(optinal, only used by Token Authentication)
`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(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`	`setFlowControl(int flowControl)` set flow control for send speed.
`void`	`setiOSEnvironment(String iOSEnvironment)` set iOS Environment(optinal, default is production environment).
`void`	`setMessage(String message)` Sets the message that will be shown in the notification.
`void`	`setNotificationId(String notificationId)` set notification id(optional).
`void`	`setPushDate(Date date)` Set the push date at which the push will be sent.
`void`	`setPushToAndroid(boolean pushToAndroid)` set push target only android device.
`void`	`setPushToIOS(boolean pushToIOS)` set push target only ios device.
`void`	`setPushToWindowsPhone(boolean pushToWP)` set push target only windows phone device.
`void`	`setQuery(LCQuery<? extends LCInstallation> query)` Sets the query for this push for which this push notification will be sent.
`void`	`setRequestId(String requestId)` set customized request id(optional).

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

- Field Detail
  - iOSEnvironmentDev
```
public static final String iOSEnvironmentDev
```
    See Also:
    
    Constant Field Values
  - iOSEnvironmentProd
```
public static final String iOSEnvironmentProd
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LCPush
```
public LCPush()
```
    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()
```
    Return channel set.
    
    Returns:
    
    channel set.
  - getNotification
```
public LCObject getNotification()
```
    Return the instance of _Notification。
    
    Returns:
    
    notification instance.
  - getPushQuery
```
public LCQuery<? extends LCInstallation> getPushQuery()
```
    Return push query instance.
    
    Returns:
    
    push query instance.
  - getPushDate
```
public Date getPushDate()
```
    Get push date.
    
    Returns:
    
    push date
  - getExpirationTime
```
public long getExpirationTime()
```
    Get expiration time.
    
    Returns:
    
    expiration time
  - getExpirationTimeInterval
```
public long getExpirationTimeInterval()
```
    Get expiration time interval.
    
    Returns:
    
    expiration time interval
  - getPushTarget
```
public Set<String> getPushTarget()
```
    Get push target.
    
    Returns:
    
    push target
  - getPushData
```
public Map<String,Object> getPushData()
```
    Get push data.
    
    Returns:
    
    push data
  - getFlowControl
```
public int getFlowControl()
```
    Get push flow control value.
    
    Returns:
    
    flow control value.
  - setFlowControl
```
public void setFlowControl(int flowControl)
```
    set flow control for send speed. flow control value indicates how many devices will be pushed per second. the min value is 1000, if flowControl less than 1000, it will be replaced with 1000.
    
    Parameters:
    
    flowControl - flow control value which stands how many devices will be pushed per second.
    
    Since:
    
    6.1.2
  - setiOSEnvironment
```
public void setiOSEnvironment(String iOSEnvironment)
```
    set iOS Environment(optinal, default is production environment). When using Token Authentication, this parameter determines which of environment(dev or prod) will become the push target.
    
    Parameters:
    
    iOSEnvironment - iOS environment, allowed values as following: AVPush.iOSEnvironmentDev("dev") - development environment AVPush.iOSEnvironmentProd("prod") - production environment
    
    Since:
    
    6.5.2
  - setAPNsTopic
```
public void setAPNsTopic(String APNsTopic)
```
    set APNs Topic(optinal, only used by Token Authentication)
    
    Parameters:
    
    APNsTopic - apns topic
    
    Since:
    
    6.5.2
  - setAPNsTeamId
```
public void setAPNsTeamId(String APNsTeamId)
```
    set APNs Team Id(optinal, only used by Token Authentication)
    
    Parameters:
    
    APNsTeamId - apns team id.
    
    Since:
    
    6.5.2
  - setNotificationId
```
public void setNotificationId(String notificationId)
```
    set notification id(optional). at now, notification id's max length is 16 characters, only letter and number is valid.
    
    Parameters:
    
    notificationId - customized notification id.
  - setRequestId
```
public void setRequestId(String requestId)
```
    set customized request id(optional). at now, request id's max length is 16 characters, only letter and number is valid. when many requests with the same request id within 5 minutes, only one request works.
    
    Parameters:
    
    requestId - customized request id.
  - 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 - channel string.
  - 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 - channel collection.
  - 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.
    
    Since:
    
    1.4.4
  - setData
```
public void setData(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 - timestamp.
  - 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 - time interval.
  - 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 - push message.
  - setPushToAndroid
```
public void setPushToAndroid(boolean pushToAndroid)
```
    set push target only android device.
    
    Parameters:
    
    pushToAndroid - flag to push to android or not.
  - setPushToIOS
```
public void setPushToIOS(boolean pushToIOS)
```
    set push target only ios device.
    
    Parameters:
    
    pushToIOS - flag to push to iOS or not.
  - setPushToWindowsPhone
```
public void setPushToWindowsPhone(boolean pushToWP)
```
    set push target only windows phone device.
    
    Parameters:
    
    pushToWP - flag to push to Windows Phone or not.
  - setQuery
```
public void setQuery(LCQuery<? extends LCInstallation> 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 - query cql.
    
    Since:
    
    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<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.
    
    Returns:
    
    observable instance.
  - 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.
    
    Parameters:
    
    callback - callback.done(e) is called when the send completes.
  - sendDataInBackground
```
public static void sendDataInBackground(JSONObject data,
                                        LCQuery<? extends LCInstallation> 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);
 
```
    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.
  - sendDataInBackground
```
public static io.reactivex.Observable<JSONObject> sendDataInBackground(JSONObject data,
                                                                       LCQuery<? extends LCInstallation> 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);
 
```
    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.
    
    Returns:
    
    observable instance.
  - sendMessageInBackground
```
public static io.reactivex.Observable<JSONObject> sendMessageInBackground(String message,
                                                                          LCQuery<? extends LCInstallation> 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.
    
    Returns:
    
    observable instance.
  - sendMessageInBackground
```
public static void sendMessageInBackground(String message,
                                           LCQuery<? extends LCInstallation> 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);
 
```
    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.

Class LCPush

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

iOSEnvironmentDev

iOSEnvironmentProd

Constructor Detail

LCPush

Method Detail

getChannelSet

getNotification

getPushQuery

getPushDate

getExpirationTime

getExpirationTimeInterval

getPushTarget

getPushData

getFlowControl

setFlowControl

setiOSEnvironment

setAPNsTopic

setAPNsTeamId

setNotificationId

setRequestId

setChannel

setChannels

setData

setData

setPushDate

setExpirationTime

setExpirationTimeInterval

setMessage

setPushToAndroid

setPushToIOS

setPushToWindowsPhone

setQuery

setCloudQuery

clearExpiration

send

sendInBackground

sendInBackground

sendDataInBackground

sendDataInBackground

sendMessageInBackground

sendMessageInBackground