public class

PermissionsManager

extends Object
java.lang.Object
   ↳ com.urbanairship.permission.PermissionsManager

Class Overview

Airship permission manager. Airship will provide the default handling for notifications. Other Permission needs to be handled by the application by setting a delegate with PermissionDelegate.

Summary

Public Methods
void addOnPermissionStatusChangedListener(OnPermissionStatusChangedListener listener)
Adds a permission status changed listener.
void checkPermissionStatus(Permission permission, Consumer<PermissionStatus> callback)
Checks the current permission status.
PendingResult<PermissionStatus> checkPermissionStatus(Permission permission)
Checks the current permission status.
Set<Permission> getConfiguredPermissions()
Gets the set of permissions that have a delegate.
void removeOnPermissionStatusChangedListener(OnPermissionStatusChangedListener listener)
Removes a permission status changed listener.
void requestPermission(Permission permission, boolean enableAirshipUsageOnGrant, Consumer<PermissionRequestResult> callback)
Requests a permission.
PendingResult<PermissionRequestResult> requestPermission(Permission permission)
Requests a permission.
void requestPermission(Permission permission, Consumer<PermissionRequestResult> callback)
Requests a permission.
PendingResult<PermissionRequestResult> requestPermission(Permission permission, boolean enableAirshipUsageOnGrant)
Requests a permission.
void setPermissionDelegate(Permission permission, PermissionDelegate delegate)
Sets a delegate to handle permissions.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void addOnPermissionStatusChangedListener (OnPermissionStatusChangedListener listener)

Adds a permission status changed listener.

Parameters
listener The listener to remove.

public void checkPermissionStatus (Permission permission, Consumer<PermissionStatus> callback)

Checks the current permission status.

Parameters
permission The permission.
callback The callback with the result.

public PendingResult<PermissionStatus> checkPermissionStatus (Permission permission)

Checks the current permission status.

Parameters
permission The permission.
Returns
  • A pending result.

public Set<Permission> getConfiguredPermissions ()

Gets the set of permissions that have a delegate.

Returns
  • The set of configured permissions.

public void removeOnPermissionStatusChangedListener (OnPermissionStatusChangedListener listener)

Removes a permission status changed listener.

Parameters
listener The listener to remove.

public void requestPermission (Permission permission, boolean enableAirshipUsageOnGrant, Consumer<PermissionRequestResult> callback)

Requests a permission.

Parameters
permission The permission.
enableAirshipUsageOnGrant If granted, any Airship features that need the permission will be enabled, e.g., enabling FEATURE_PUSH and setUserNotificationsEnabled(boolean) if the push permission is granted.
callback The callback.

public PendingResult<PermissionRequestResult> requestPermission (Permission permission)

Requests a permission. If a delegate is not set to handle the permission NOT_DETERMINED will be returned.

Parameters
permission The permission.
Returns
  • A pending result.

public void requestPermission (Permission permission, Consumer<PermissionRequestResult> callback)

Requests a permission.

Parameters
permission The permission.
callback The callback.

public PendingResult<PermissionRequestResult> requestPermission (Permission permission, boolean enableAirshipUsageOnGrant)

Requests a permission. If a delegate is not set to handle the permission NOT_DETERMINED will be returned.

Parameters
permission The permission.
enableAirshipUsageOnGrant If granted, any Airship features that need the permission will be enabled, e.g., enabling FEATURE_PUSH and setUserNotificationsEnabled(boolean) if the push permission is granted.
Returns
  • A pending result.

public void setPermissionDelegate (Permission permission, PermissionDelegate delegate)

Sets a delegate to handle permissions.

Parameters
permission The permission.
delegate The delegate.