@ProviderType
public class PushNotificationsDeviceLocalServiceUtil
extends java.lang.Object
com.liferay.push.notifications.service.impl.PushNotificationsDeviceLocalServiceImpl
and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.PushNotificationsDeviceLocalService
,
com.liferay.push.notifications.service.base.PushNotificationsDeviceLocalServiceBaseImpl
,
com.liferay.push.notifications.service.impl.PushNotificationsDeviceLocalServiceImpl
Constructor and Description |
---|
PushNotificationsDeviceLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static PushNotificationsDevice |
addPushNotificationsDevice(long userId,
java.lang.String platform,
java.lang.String token) |
static PushNotificationsDevice |
addPushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
Adds the push notifications device to the database.
|
static PushNotificationsDevice |
createPushNotificationsDevice(long pushNotificationsDeviceId)
Creates a new push notifications device with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static PushNotificationsDevice |
deletePushNotificationsDevice(long pushNotificationsDeviceId)
Deletes the push notifications device with the primary key from the database.
|
static PushNotificationsDevice |
deletePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
Deletes the push notifications device from the database.
|
static PushNotificationsDevice |
deletePushNotificationsDevice(java.lang.String token) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static PushNotificationsDevice |
fetchPushNotificationsDevice(long pushNotificationsDeviceId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static PushNotificationsDevice |
getPushNotificationsDevice(long pushNotificationsDeviceId)
Returns the push notifications device with the primary key.
|
static java.util.List<PushNotificationsDevice> |
getPushNotificationsDevices(int start,
int end)
Returns a range of all the push notifications devices.
|
static java.util.List<PushNotificationsDevice> |
getPushNotificationsDevices(int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<PushNotificationsDevice> orderByComparator) |
static int |
getPushNotificationsDevicesCount()
Returns the number of push notifications devices.
|
static PushNotificationsDeviceLocalService |
getService() |
static void |
sendPushNotification(long[] toUserIds,
com.liferay.portal.kernel.json.JSONObject payloadJSONObject) |
static void |
sendPushNotification(java.lang.String platform,
java.util.List<java.lang.String> tokens,
com.liferay.portal.kernel.json.JSONObject payloadJSONObject) |
static PushNotificationsDevice |
updatePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
Updates the push notifications device in the database or adds it if it does not yet exist.
|
static void |
updateToken(java.lang.String oldToken,
java.lang.String newToken) |
public PushNotificationsDeviceLocalServiceUtil()
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static PushNotificationsDevice addPushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
pushNotificationsDevice
- the push notifications devicepublic static PushNotificationsDevice addPushNotificationsDevice(long userId, java.lang.String platform, java.lang.String token) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static PushNotificationsDevice createPushNotificationsDevice(long pushNotificationsDeviceId)
pushNotificationsDeviceId
- the primary key for the new push notifications devicepublic static PushNotificationsDevice deletePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
pushNotificationsDevice
- the push notifications devicepublic static PushNotificationsDevice deletePushNotificationsDevice(java.lang.String token) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static PushNotificationsDevice deletePushNotificationsDevice(long pushNotificationsDeviceId) throws com.liferay.portal.kernel.exception.PortalException
pushNotificationsDeviceId
- the primary key of the push notifications devicePortalException
- if a push notifications device with the primary key could not be foundpublic static PushNotificationsDevice fetchPushNotificationsDevice(long pushNotificationsDeviceId)
public static PushNotificationsDevice getPushNotificationsDevice(long pushNotificationsDeviceId) throws com.liferay.portal.kernel.exception.PortalException
pushNotificationsDeviceId
- the primary key of the push notifications devicePortalException
- if a push notifications device with the primary key could not be foundpublic static PushNotificationsDevice updatePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)
pushNotificationsDevice
- the push notifications devicepublic static int getPushNotificationsDevicesCount()
public static java.lang.String getOSGiServiceIdentifier()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static java.util.List<PushNotificationsDevice> getPushNotificationsDevices(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of push notifications devicesend
- the upper bound of the range of push notifications devices (not inclusive)public static java.util.List<PushNotificationsDevice> getPushNotificationsDevices(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<PushNotificationsDevice> orderByComparator)
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static void sendPushNotification(java.lang.String platform, java.util.List<java.lang.String> tokens, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void sendPushNotification(long[] toUserIds, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void updateToken(java.lang.String oldToken, java.lang.String newToken) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static PushNotificationsDeviceLocalService getService()