Class PushNotificationsDeviceLocalServiceUtil

java.lang.Object
com.liferay.push.notifications.service.PushNotificationsDeviceLocalServiceUtil

public class PushNotificationsDeviceLocalServiceUtil extends Object
Provides the local service utility for PushNotificationsDevice. This utility wraps com.liferay.push.notifications.service.impl.PushNotificationsDeviceLocalServiceImpl and is an 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.
See Also:
Generated:
  • Constructor Details

    • PushNotificationsDeviceLocalServiceUtil

      public PushNotificationsDeviceLocalServiceUtil()
  • Method Details

    • addPushNotificationsDevice

      public static PushNotificationsDevice addPushNotificationsDevice(long userId, String platform, String token) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addPushNotificationsDevice

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createPushNotificationsDevice

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePushNotificationsDevice

      public static 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

      public static 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

      public static PushNotificationsDevice deletePushNotificationsDevice(String token) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      public static <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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      public static 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

      public 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.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchPushNotificationsDevice

      public static PushNotificationsDevice fetchPushNotificationsDevice(long pushNotificationsDeviceId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getPushNotificationsDevice

      public static 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

      public static 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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

      Parameters:
      start - the lower bound of the range of push notifications devices
      end - the upper bound of the range of push notifications devices (not inclusive)
      Returns:
      the range of push notifications devices
    • getPushNotificationsDevices

      public static List<PushNotificationsDevice> getPushNotificationsDevices(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<PushNotificationsDevice> orderByComparator)
    • getPushNotificationsDevicesCount

      public static int getPushNotificationsDevicesCount()
      Returns the number of push notifications devices.
      Returns:
      the number of push notifications devices
    • sendPushNotification

      public static 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

      public static 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

      public static 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

      public static void updateToken(String oldToken, String newToken) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static PushNotificationsDeviceLocalService getService()