com.scvngr.levelup.core.model

Class PermissionsRequest

java.lang.Object

com.scvngr.levelup.core.model.PermissionsRequest

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=ENTERPRISE)
public final class PermissionsRequest
extends Object
implements Parcelable

A request for a set of permissions, made by an App on behalf of the user. Typically, this is used to construct an interface which presents the set of permissions to the user alongside the App details, prompting them to accept or reject the App's request for the permissions. If accepted, the app is then granted an AccessToken which lets it wield these permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermissionsRequest.State The state of the permissions request, according to the web service.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<PermissionsRequest>	CREATOR Implements the Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
PermissionsRequest(String acceptText, long appId, String createdAt, String description, long id, Set<Permission> permissions, String rejectText, PermissionsRequest.State state) Deprecated. see PermissionsRequest(String, long, String, String, long, java.util.Set, String, com.scvngr.levelup.core.model.PermissionsRequest.State, String).
PermissionsRequest(String acceptText, long appId, String createdAt, String description, long id, Set<Permission> permissions, String rejectText, PermissionsRequest.State state, String token)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
String	getAcceptText() The text to display to the user on the "Accept" affordance.
long	getAppId() The ID of the app this request is for.
String	getCreatedAt() The date this request was created.
String	getDescription() A short, human-readable description of this permissions request.
long	getId() The web service ID of this request.
Set<Permission>	getPermissions() The set of permissions being requested.
String	getRejectText() The text to display to the user on the "Reject" affordance.
PermissionsRequest.State	getState() The state of the request.
String	getToken() The access token, if one was provided by the web service.
int	hashCode()
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<PermissionsRequest> CREATOR

Implements the Parcelable interface.

Constructor Detail

PermissionsRequest

@Deprecated
public PermissionsRequest(String acceptText,
                                      long appId,
                                      String createdAt,
                                      String description,
                                      long id,
                                      Set<Permission> permissions,
                                      String rejectText,
                                      PermissionsRequest.State state)

Deprecated. see PermissionsRequest(String, long, String, String, long, java.util.Set, String, com.scvngr.levelup.core.model.PermissionsRequest.State, String).

PermissionsRequest

public PermissionsRequest(String acceptText,
                          long appId,
                          String createdAt,
                          String description,
                          long id,
                          Set<Permission> permissions,
                          String rejectText,
                          PermissionsRequest.State state,
                          String token)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getAcceptText

public String getAcceptText()

The text to display to the user on the "Accept" affordance.

getAppId

public long getAppId()

The ID of the app this request is for.

getCreatedAt

public String getCreatedAt()

The date this request was created.

getDescription

public String getDescription()

A short, human-readable description of this permissions request.

getId

public long getId()

The web service ID of this request.

getPermissions

public Set<Permission> getPermissions()

The set of permissions being requested. All of these must be presented when displaying this permissions request.

getRejectText

public String getRejectText()

The text to display to the user on the "Reject" affordance.

getState

public PermissionsRequest.State getState()

The state of the request.

getToken

public String getToken()

The access token, if one was provided by the web service.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object