Interface PushNotificationsDeviceLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
PushNotificationsDeviceLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddPushNotificationsDevice
(long userId, String platform, String token) addPushNotificationsDevice
(PushNotificationsDevice pushNotificationsDevice) Adds the push notifications device to the database.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) createPushNotificationsDevice
(long pushNotificationsDeviceId) Creates a new push notifications device with the primary key.com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) deletePushNotificationsDevice
(long pushNotificationsDeviceId) Deletes the push notifications device with the primary key from the database.deletePushNotificationsDevice
(PushNotificationsDevice pushNotificationsDevice) Deletes the push notifications device from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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.<T> 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.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchPushNotificationsDevice
(long pushNotificationsDeviceId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getPushNotificationsDevice
(long pushNotificationsDeviceId) Returns the push notifications device with the primary key.getPushNotificationsDevices
(int start, int end) Returns a range of all the push notifications devices.getPushNotificationsDevices
(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<PushNotificationsDevice> orderByComparator) int
Returns the number of push notifications devices.void
sendPushNotification
(long[] toUserIds, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) void
sendPushNotification
(String platform, List<String> tokens, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) updatePushNotificationsDevice
(PushNotificationsDevice pushNotificationsDevice) Updates the push notifications device in the database or adds it if it does not yet exist.void
updateToken
(String oldToken, String newToken) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPushNotificationsDevice
PushNotificationsDevice addPushNotificationsDevice(long userId, String platform, String token) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addPushNotificationsDevice
@Indexable(type=REINDEX) PushNotificationsDevice addPushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Adds the push notifications device to the database. Also notifies the appropriate model listeners.Important: Inspect PushNotificationsDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
pushNotificationsDevice
- the push notifications device- Returns:
- the push notifications device that was added
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createPushNotificationsDevice
@Transactional(enabled=false) PushNotificationsDevice createPushNotificationsDevice(long pushNotificationsDeviceId) Creates a new push notifications device with the primary key. Does not add the push notifications device to the database.- Parameters:
pushNotificationsDeviceId
- the primary key for the new push notifications device- Returns:
- the new push notifications device
-
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePushNotificationsDevice
@Indexable(type=DELETE) PushNotificationsDevice deletePushNotificationsDevice(long pushNotificationsDeviceId) throws com.liferay.portal.kernel.exception.PortalException Deletes the push notifications device with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PushNotificationsDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
pushNotificationsDeviceId
- the primary key of the push notifications device- Returns:
- the push notifications device that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a push notifications device with the primary key could not be found
-
deletePushNotificationsDevice
@Indexable(type=DELETE) PushNotificationsDevice deletePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Deletes the push notifications device from the database. Also notifies the appropriate model listeners.Important: Inspect PushNotificationsDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
pushNotificationsDevice
- the push notifications device- Returns:
- the push notifications device that was removed
-
deletePushNotificationsDevice
PushNotificationsDevice deletePushNotificationsDevice(String token) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPushNotificationsDevice
@Transactional(propagation=SUPPORTS, readOnly=true) PushNotificationsDevice fetchPushNotificationsDevice(long pushNotificationsDeviceId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPushNotificationsDevice
@Transactional(propagation=SUPPORTS, readOnly=true) PushNotificationsDevice getPushNotificationsDevice(long pushNotificationsDeviceId) throws com.liferay.portal.kernel.exception.PortalException Returns the push notifications device with the primary key.- Parameters:
pushNotificationsDeviceId
- the primary key of the push notifications device- Returns:
- the push notifications device
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a push notifications device with the primary key could not be found
-
getPushNotificationsDevices
@Transactional(propagation=SUPPORTS, readOnly=true) List<PushNotificationsDevice> getPushNotificationsDevices(int start, int end) Returns a range of all the push notifications devices.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl
.- Parameters:
start
- the lower bound of the range of push notifications devicesend
- the upper bound of the range of push notifications devices (not inclusive)- Returns:
- the range of push notifications devices
-
getPushNotificationsDevices
@Transactional(propagation=SUPPORTS, readOnly=true) List<PushNotificationsDevice> getPushNotificationsDevices(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<PushNotificationsDevice> orderByComparator) -
getPushNotificationsDevicesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getPushNotificationsDevicesCount()Returns the number of push notifications devices.- Returns:
- the number of push notifications devices
-
sendPushNotification
void sendPushNotification(long[] toUserIds, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
sendPushNotification
void sendPushNotification(String platform, List<String> tokens, com.liferay.portal.kernel.json.JSONObject payloadJSONObject) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updatePushNotificationsDevice
@Indexable(type=REINDEX) PushNotificationsDevice updatePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Updates the push notifications device in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PushNotificationsDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
pushNotificationsDevice
- the push notifications device- Returns:
- the push notifications device that was updated
-
updateToken
void updateToken(String oldToken, String newToken) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-