User (audiobox-jlib 1.0.4 API)

java.lang.Object
- java.util.Observable
- - fm.audiobox.core.models.Model
  - - fm.audiobox.core.models.User

```
public class User
extends Model
```
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.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCEPTED_EXTENSIONS`
`static java.lang.String`	`ACCEPTED_FORMATS`
`static java.lang.String`	`COMET_CHANNEL`
`static java.lang.String`	`COUNTRY`
`static java.lang.String`	`CREATED_AT`
`static java.lang.String`	`MEDIA_FILES_COUNT`
`static java.lang.String`	`OFFLINE_PLAYLIST`
`static java.lang.String`	`PLAN`
`static java.lang.String`	`PLAYLISTS_COUNT`
`static java.lang.String`	`REAL_NAME`
`static java.lang.String`	`SUBSCRIPTION_STATE`
`static java.lang.String`	`TIME_ZONE`
`static java.lang.String`	`TOTAL_PLAY_COUNT`
`static java.lang.String`	`UPDATED_AT`

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcceptedExtensions()` Gets accepted extensions.
`java.lang.String`	`getAcceptedFormats()` Gets accepted formats.
`java.lang.String`	`getAuthToken()` Gets the current authentication token for the user.
`java.lang.String`	`getCometChannel()` Gets the unique push engine channel for this user.
`java.lang.String`	`getCountry()` Gets country.
`java.lang.String`	`getCreatedAt()` Gets the user creation time (in form of an UTC String).
`java.lang.String`	`getEmail()` Gets email.
`ExternalTokens`	`getExternalTokens()` Gets the user's `ExternalTokens` that indicates if AudioBox have stored an OAuth token for the user.
`long`	`getId()` Gets id.
`long`	`getMediaFilesCount()` Gets total media files count.
`java.lang.String`	`getOfflinePlaylist()` Gets offline playlist token.
`Permissions`	`getPermissions()` Gets the hash that defines the boolean permissions the user has access to, depending on subscription state if it's a paid feature.
`java.lang.String`	`getPlan()` Gets the plan name the user is subscribed to, if any..
`long`	`getPlaylistsCount()` Gets playlists count.
`Preferences`	`getPreferences()` Gets the user's `Preferences` Preferences are never null
`java.lang.String`	`getRealName()` Gets real name.
`Stats`	`getStats()` Gets the user's `Stats`
`java.lang.String`	`getSubscriptionState()` Gets the string identifying the paid subscription states for this user.
`java.lang.String`	`getTimeZone()` Gets time zone.
`long`	`getTotalPlayCount()` Gets total play count.
`java.lang.String`	`getUpdatedAt()` Gets the last time (in form of an UTC String) this account have been changed.
`boolean`	`savePreferences(AudioBoxClient audioBoxClient)` Saves user preferences

Methods inherited from class fm.audiobox.core.models.Model
getProp, notifyObservers, setProp

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REAL_NAME
```
public static final java.lang.String REAL_NAME
```
    See Also:
    Constant Field Values
  - TIME_ZONE
```
public static final java.lang.String TIME_ZONE
```
    See Also:
    Constant Field Values
  - ACCEPTED_EXTENSIONS
```
public static final java.lang.String ACCEPTED_EXTENSIONS
```
    See Also:
    Constant Field Values
  - ACCEPTED_FORMATS
```
public static final java.lang.String ACCEPTED_FORMATS
```
    See Also:
    Constant Field Values
  - COUNTRY
```
public static final java.lang.String COUNTRY
```
    See Also:
    Constant Field Values
  - PLAYLISTS_COUNT
```
public static final java.lang.String PLAYLISTS_COUNT
```
    See Also:
    Constant Field Values
  - TOTAL_PLAY_COUNT
```
public static final java.lang.String TOTAL_PLAY_COUNT
```
    See Also:
    Constant Field Values
  - MEDIA_FILES_COUNT
```
public static final java.lang.String MEDIA_FILES_COUNT
```
    See Also:
    Constant Field Values
  - SUBSCRIPTION_STATE
```
public static final java.lang.String SUBSCRIPTION_STATE
```
    See Also:
    Constant Field Values
  - COMET_CHANNEL
```
public static final java.lang.String COMET_CHANNEL
```
    See Also:
    Constant Field Values
  - PLAN
```
public static final java.lang.String PLAN
```
    See Also:
    Constant Field Values
  - CREATED_AT
```
public static final java.lang.String CREATED_AT
```
    See Also:
    Constant Field Values
  - UPDATED_AT
```
public static final java.lang.String UPDATED_AT
```
    See Also:
    Constant Field Values
  - OFFLINE_PLAYLIST
```
public static final java.lang.String OFFLINE_PLAYLIST
```
    See Also:
    Constant Field Values
- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - getId
```
public long getId()
```
    Gets id.
    
    Returns:
    the id
  - getCreatedAt
```
public java.lang.String getCreatedAt()
```
    Gets the user creation time (in form of an UTC String).
    
    Returns:
    the UTC String of the user creation time
  - getUpdatedAt
```
public java.lang.String getUpdatedAt()
```
    Gets the last time (in form of an UTC String) this account have been changed.
    NOTE: Since client timezone may differ significantly you are strongly invited to always trust and use this datetime in case you are building a sync tool.
    
    Returns:
    the UTC String of the last update on this account
  - getRealName
```
public java.lang.String getRealName()
```
    Gets real name.
    
    Returns:
    the real name
  - getEmail
```
public java.lang.String getEmail()
```
    Gets email.
    
    Returns:
    the email
  - getAuthToken
```
public java.lang.String getAuthToken()
```
    Gets the current authentication token for the user. This attribute can change and might be rotated at any time.
    
    Returns:
    the auth token
  - getMediaFilesCount
```
public long getMediaFilesCount()
```
    Gets total media files count.
    
    Returns:
    the media files count
  - getPlaylistsCount
```
public long getPlaylistsCount()
```
    Gets playlists count.
    
    Returns:
    the playlists count
  - getTotalPlayCount
```
public long getTotalPlayCount()
```
    Gets total play count.
    
    Returns:
    the total play count
  - getCountry
```
public java.lang.String getCountry()
```
    Gets country.
    
    Returns:
    the country
  - getTimeZone
```
public java.lang.String getTimeZone()
```
    Gets time zone.
    
    Returns:
    the time zone
  - getAcceptedExtensions
```
public java.lang.String getAcceptedExtensions()
```
    Gets accepted extensions.
    
    Returns:
    the accepted extensions
  - getAcceptedFormats
```
public java.lang.String getAcceptedFormats()
```
    Gets accepted formats.
    
    Returns:
    the accepted formats
  - getCometChannel
```
public java.lang.String getCometChannel()
```
    Gets 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.
    
    Returns:
    the comet channel
  - getSubscriptionState
```
public java.lang.String getSubscriptionState()
```
    Gets the 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.
    
    Returns:
    the subscription state
  - getPlan
```
public java.lang.String getPlan()
```
    Gets the plan name the user is subscribed to, if any..
    
    Returns:
    the plan
  - getOfflinePlaylist
```
public java.lang.String getOfflinePlaylist()
```
    Gets offline playlist token.
    
    Returns:
    the offline playlist token
  - getPermissions
```
public Permissions getPermissions()
```
    Gets the hash that 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.
    
    Returns:
    the user's Permissions
  - getExternalTokens
```
public ExternalTokens getExternalTokens()
```
    Gets the user's ExternalTokens that indicates if AudioBox have stored an OAuth token for the user.
    Such attributes are automatically set by the system and cannot be changed manually.
    
    Returns:
    the external tokens
  - getStats
```
public Stats getStats()
```
    Gets the user's Stats
    
    Returns:
    the stats
  - getPreferences
```
public Preferences getPreferences()
```
    Gets the user's Preferences
    Preferences are never null
    
    Returns:
    the preferences
  - savePreferences
```
public boolean savePreferences(AudioBoxClient audioBoxClient)
                        throws java.io.IOException
```
    Saves user preferences
    
    Parameters:
    audioBoxClient - the client
    
    Returns:
    true if operation succeed throws an exception if something goes wrong
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException - if any connection problem occurs.
    See Also:
    AudioBoxException

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class fm.audiobox.core.models.Model

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Field Detail

REAL_NAME

TIME_ZONE

ACCEPTED_EXTENSIONS

ACCEPTED_FORMATS

COUNTRY

PLAYLISTS_COUNT

TOTAL_PLAY_COUNT

MEDIA_FILES_COUNT

SUBSCRIPTION_STATE

COMET_CHANNEL

PLAN

CREATED_AT

UPDATED_AT

OFFLINE_PLAYLIST

Constructor Detail

User

Method Detail

getId

getCreatedAt

getUpdatedAt

getRealName

getEmail

getAuthToken

getMediaFilesCount

getPlaylistsCount

getTotalPlayCount

getCountry

getTimeZone

getAcceptedExtensions

getAcceptedFormats

getCometChannel

getSubscriptionState

getPlan

getOfflinePlaylist

getPermissions

getExternalTokens

getStats

getPreferences

savePreferences