User

Class Overview

A User can interact with his own files in different ways, depending on the remote storage in play.

However AudioBox is built with homogeneity in mind and therefore you will end up calling the same methods for different, powerful actions.

For the most part the returned attributes are straightforward, such as media_files_count, however there are special attributes to explain:

auth_token:

The current authentication token for the user. This attribute can change and might be rotated at any time.

permissions: {...}

A user can subscribe and manage multiple remote storage services. This hash defines the boolean permissions the user has access to, depending on subscription state if it's a paid feature. In case the User has been created through a Partner it will inherit permissions depending on the Partner requested features. Such attributes are automatically set by the system and cannot be changed manually.

external_tokens: {...}

For each of the external services the boolean value indicates if we have stored a OAuth token for the user. Such attributes are automatically set by the system and cannot be changed manually.

stats: {...}

Bytes long values showing the storage used for each supported storage service and the amount of data that has been streamed.

subscription_state:

String identifying the paid subscription states for this user. Some features cannot be accessed if the subscription is not valid. We suggest to not use logic in your own application against this attribute, but rather query the permissions: {} data to have more fine-grained control over the available actions. Possible values are: active, trialing, past_due, canceled and unpaid.

plan:

The plan name the user is subscribed to, if any.

comet_channel:

The unique push engine channel for this user. AudioBox employ push notifications, by making the application subscribe to this channel name it will be able to receive actions to perform in the user interface. Using push messages is a great way to keep all the applications in sync when an action is performed, such as media add. Further documentation on how to connect to the push server will be provided soon.

preferences: {...}

General preferences of the user, mostly used in the Cloud Web Player.

Summary

[Expand] Inherited Methods
From class fm.audiobox.core.models.Model final Object getProp(String key) Gets the requested property or null. void notifyObservers(Object arg) final void setProp(String key, Object value) Sets a property to the model
From class java.util.Observable synchronized void addObserver(Observer arg0) synchronized void clearChanged() synchronized int countObservers() synchronized void deleteObserver(Observer arg0) synchronized void deleteObservers() synchronized boolean hasChanged() void notifyObservers() void notifyObservers(Object arg0) synchronized void setChanged()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)