xappmedia.sdk.permissions.ui

Class Permission

java.lang.Object

xappmedia.sdk.permissions.ui.Permission

All Implemented Interfaces:

android.os.Parcelable

public class Permission
extends java.lang.Object
implements android.os.Parcelable

Pojo to represent a Permission with the rationale.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Permission.Builder

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Permission>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
java.lang.String	getName() Returns the name of the given permission.
int	hashCode()
int	imageResourceDrawable() For permissions dialogs with images, this is the image that represents the permission.
java.lang.String	imageUri() For permissions dialogs with images, this is the image that represents the permission.
Permission.Builder	newFromThis(java.lang.String permission) Creates a copy of this permission with a new permission string.
static Permission.Builder	newPermission(java.lang.String permission)
java.lang.String	permission()
java.lang.String	rationale() A rationale to display to the user as to why they need this permission.
java.lang.String	title() The title or name of the permission to display.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<Permission> CREATOR

Method Detail

newPermission

public static Permission.Builder newPermission(java.lang.String permission)

Parameters:

permission - Name of the permission this represents.

Returns:

Builder to generate the new permission.

See Also:

Manifest.permission

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

newFromThis

public Permission.Builder newFromThis(java.lang.String permission)

Creates a copy of this permission with a new permission string.

Parameters:

permission - New permission string to build from.

Returns:

Builder to make any adjustments to the new permission.

rationale

public java.lang.String rationale()

A rationale to display to the user as to why they need this permission.

Returns:

Rationale set in this permission. Can be null.

imageUri

public java.lang.String imageUri()

For permissions dialogs with images, this is the image that represents the permission.

Returns:

String file location of the image. Can be null.

imageResourceDrawable

public int imageResourceDrawable()

For permissions dialogs with images, this is the image that represents the permission. This takes precedence over imageUri()

Returns:

Resource ID of the image that represents this permission. Less than 0 for not set.

permission

public java.lang.String permission()

Returns:

Permission name that this represents.

title

public java.lang.String title()

The title or name of the permission to display. By default, this will be the actual permission itself. However, Android permissions are generally titled "android.permission.RECORD_AUDIO" or something similar. This may be confusing, so it is encouraged to include a name.

Returns:

Title assigned to this permission.

getName

public java.lang.String getName()

Returns the name of the given permission. Convenience method which will basically return the title if there is one or the permission name if the title is not provided.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object