API reference
API reference
Select your platform
No SDKs available
No versions available

UserCapability Class

This object represents a permission or capability for the logged in user, which can be retrieved by com.meta.horizon.platform.ovr.requests.Users#getLoggedInUser(). It's a type of array and there is a unique name for every user capability.

Constructors

UserCapability ( ptr )
Signature
com.meta.horizon.platform.ovr.models.UserCapability.UserCapability(final long ptr)
Parameters
ptr: final long

Methods

getDescription ()
The human readable description of the capability describing what possessing it entails for a given com.meta.horizon.platform.ovr.models.User.
Signature
String com.meta.horizon.platform.ovr.models.UserCapability.getDescription()
Returns
String  String
getIsEnabled ()
Whether the capability is currently enabled for the user. When false, this field will gate the com.meta.horizon.platform.ovr.models.User from the specified services.
Signature
boolean com.meta.horizon.platform.ovr.models.UserCapability.getIsEnabled()
Returns
boolean  boolean
getName ()
The unique identifier for the capability. An example capability could be "earn_achievements".
Signature
String com.meta.horizon.platform.ovr.models.UserCapability.getName()
Returns
String  String
getReasonCode ()
This field specifies the reason the capability was enabled or disabled for the given com.meta.horizon.platform.ovr.models.User. List of Reason Codes:
  • REASON_UNKOWN
  • SOCIAL_DISTANCING
  • VERBAL_ABUSE
  • TEXT_ABUSE
  • PARENTAL_CONTROL
  • DEVELOPER_ACTION
  • SALSA_RESTRICTION
  • SOCIAL_SUSPENSION
  • PAYMENT_SUSPENSION
  • PAYMENT_GIFTING_SUSPENSION
Signature
String com.meta.horizon.platform.ovr.models.UserCapability.getReasonCode()
Returns
String  String