QBRoster (workspace API)

java.lang.Object
- com.quickblox.chat.QBRoster

```
public class QBRoster
extends java.lang.Object
```
Represents a user's roster, which is the collection of users a person receives presence updates for. Roster items are categorized into groups for easier management.

Others users may attempt to subscribe to this user using a subscription request. Two modes are supported for handling these requests:
- mutual -- accept all subscription requests mutual.
- manual -- manually process all subscription requests.
See Also:

org.jivesoftware.smack.roster.Roster

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QBRoster.SubscriptionMode
An enumeration for the subscription mode options.

Nested Classes
Modifier and Type	Class and Description
`static class`	`QBRoster.SubscriptionMode` An enumeration for the subscription mode options.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QBRoster(XMPPConnection connection)`
`protected`	`QBRoster(XMPPConnection connection, QBRoster.SubscriptionMode mode, QBSubscriptionListener subscriptionListener)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRosterListener(QBRosterListener listener)` Adds a listener to this roster.
`void`	`addSubscriptionListener(QBSubscriptionListener listener)` Adds the subscription listener
`void`	`confirmSubscription(int userId)` Confirms subscription request.
`void`	`confirmSubscription(int userId, QBEntityCallback<java.lang.Void> callback)`
`boolean`	`contains(int userId)` Returns true if the specified user is an entry in the roster.
`void`	`createEntry(int userId, java.lang.String[] groups)` Creates a new roster entry and presence subscription.
`void`	`createEntry(int userId, java.lang.String[] groups, QBEntityCallback<java.lang.Void> callback)`
`QBRosterGroup`	`createGroup(java.lang.String name)` Creates a new group.
`java.util.Collection<QBRosterEntry>`	`getEntries()` Returns an unmodifiable collection of all entries in the roster, including entries that don't belong to any groups.
`QBRosterEntry`	`getEntry(int userId)` Returns the roster entry associated with the given user identifier or `null` if the user is not an entry in the roster.
`int`	`getEntryCount()` Returns a count of the entries in the roster.
`QBRosterGroup`	`getGroup(java.lang.String name)` Returns the roster group with the specified name, or `null` if the group doesn't exist.
`int`	`getGroupCount()` Returns the number of the groups in the roster.
`java.util.Collection<QBRosterGroup>`	`getGroups()` Returns an unmodifiable collections of all the roster groups.
`QBPresence`	`getPresence(int userId)` Returns the presence info for a particular user.
`QBRoster.SubscriptionMode`	`getSubscriptionMode()` Gets roster mode.
`java.util.Collection<QBRosterEntry>`	`getUnfiledEntries()` Returns an unmodifiable collection for the unfiled roster entries.
`int`	`getUnfiledEntryCount()` Returns a count of the unfiled entries in the roster.
`protected void`	`notifyFailResult(QBEntityCallback callback, java.lang.String error)`
`protected void`	`notifySuccessResult(QBEntityCallback callback)`
`void`	`reject(int userId)` Rejects subscription request.
`void`	`reject(int userId, QBEntityCallback<java.lang.Void> callback)`
`void`	`reload()` Reloads the entire roster from the server.
`void`	`removeEntry(QBRosterEntry entry)` Removes a roster entry from the roster.
`void`	`removeEntry(QBRosterEntry entry, QBEntityCallback<java.lang.Void> callback)`
`void`	`removeRosterListener(QBRosterListener listener)` Removes roster listener
`void`	`removeSubscriptionListener(QBSubscriptionListener listener)` Removes the subscription listener
`void`	`sendPresence(QBPresence presence)` Sends presence
`void`	`sendPresence(QBPresence presence, QBEntityCallback<java.lang.Void> callback)`
`void`	`setSubscriptionMode(QBRoster.SubscriptionMode subscriptionMode)` Sets roster mode.
`void`	`subscribe(int userId)` Subscribes to user (adds to the contact list).
`void`	`subscribe(int userId, QBEntityCallback<java.lang.Void> callback)`
`void`	`unsubscribe(int userId)` Subscribes from user (removes from the contact list).
`void`	`unsubscribe(int userId, QBEntityCallback<java.lang.Void> callback)`

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

- Constructor Detail
  - QBRoster
```
protected QBRoster(XMPPConnection connection,
                   QBRoster.SubscriptionMode mode,
                   QBSubscriptionListener subscriptionListener)
```
  - QBRoster
```
protected QBRoster(XMPPConnection connection)
```
- Method Detail
  - reload
```
public void reload()
            throws SmackException.NotLoggedInException,
                   SmackException.NotConnectedException
```
    Reloads the entire roster from the server.
    
    Throws:
    
    SmackException.NotLoggedInException
    
    SmackException.NotConnectedException
  - getSubscriptionMode
```
public QBRoster.SubscriptionMode getSubscriptionMode()
```
    Gets roster mode. Two modes are supported for handling these requests:
    - mutual -- accept all subscription requests mutual.
    - manual -- manually process all subscription requests.
  - setSubscriptionMode
```
public void setSubscriptionMode(QBRoster.SubscriptionMode subscriptionMode)
```
    Sets roster mode. Two modes are supported for handling these requests:
    - mutual -- accept all subscription requests mutual.
    - manual -- manually process all subscription requests.
    Parameters:
    
    subscriptionMode - The roster mode to set.
  - createGroup
```
public QBRosterGroup createGroup(java.lang.String name)
                          throws SmackException.NotLoggedInException
```
    Creates a new group.
    
    Parameters:
    
    name - The name of the group.
    
    Returns:
    
    a new group, or null if the group already exists
    
    Throws:
    
    SmackException.NotLoggedInException
  - getGroup
```
public QBRosterGroup getGroup(java.lang.String name)
```
    Returns the roster group with the specified name, or null if the group doesn't exist.
    
    Parameters:
    
    name - the name of the group.
    
    Returns:
    
    the roster group with the specified name.
  - getGroupCount
```
public int getGroupCount()
```
    Returns the number of the groups in the roster.
    
    Returns:
    
    the number of groups in the roster.
  - getGroups
```
public java.util.Collection<QBRosterGroup> getGroups()
```
    Returns an unmodifiable collections of all the roster groups.
    
    Returns:
    
    an iterator for all roster groups.
  - createEntry
```
public void createEntry(int userId,
                        java.lang.String[] groups)
                 throws XMPPException,
                        SmackException.NotLoggedInException,
                        SmackException.NotConnectedException,
                        SmackException.NoResponseException
```
    Creates a new roster entry and presence subscription. The server will asynchronously update the roster with the subscription status.
    
    Parameters:
    
    groups - the list of group names the entry will belong to, or null if the the roster entry won't belong to a group.
    
    Throws:
    
    org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the server.
    
    org.jivesoftware.smack.XMPPException.XMPPErrorException - if an XMPP exception occurs.
    
    org.jivesoftware.smack.SmackException.NotLoggedInException - If not logged in.
    
    org.jivesoftware.smack.SmackException.NotConnectedException
    
    XMPPException
    
    SmackException.NotLoggedInException
    
    SmackException.NotConnectedException
    
    SmackException.NoResponseException
  - createEntry
```
public void createEntry(int userId,
                        java.lang.String[] groups,
                        QBEntityCallback<java.lang.Void> callback)
```
  - removeEntry
```
public void removeEntry(QBRosterEntry entry)
                 throws XMPPException,
                        SmackException.NotLoggedInException,
                        SmackException.NotConnectedException,
                        SmackException.NoResponseException
```
    Removes a roster entry from the roster. The roster entry will also be removed from the unfiled entries or from any roster group where it could belong and will no longer be part of the roster.
    
    Parameters:
    
    entry - a roster entry.
    
    Throws:
    
    org.jivesoftware.smack.XMPPException.XMPPErrorException - if an XMPP error occurs.
    
    org.jivesoftware.smack.SmackException.NotLoggedInException - if not logged in.
    
    org.jivesoftware.smack.SmackException.NoResponseException - SmackException if there was no response from the server.
    
    org.jivesoftware.smack.SmackException.NotConnectedException
    
    java.lang.IllegalStateException - if connection is not logged in or logged in anonymously
    
    XMPPException
    
    SmackException.NotLoggedInException
    
    SmackException.NotConnectedException
    
    SmackException.NoResponseException
  - removeEntry
```
public void removeEntry(QBRosterEntry entry,
                        QBEntityCallback<java.lang.Void> callback)
```
  - getEntryCount
```
public int getEntryCount()
```
    Returns a count of the entries in the roster.
    
    Returns:
    
    the number of entries in the roster.
  - getEntries
```
public java.util.Collection<QBRosterEntry> getEntries()
```
    Returns an unmodifiable collection of all entries in the roster, including entries that don't belong to any groups.
    
    Returns:
    
    all entries in the roster.
  - getUnfiledEntryCount
```
public int getUnfiledEntryCount()
```
    Returns a count of the unfiled entries in the roster. An unfiled entry is an entry that doesn't belong to any groups.
    
    Returns:
    
    the number of unfiled entries in the roster.
  - getUnfiledEntries
```
public java.util.Collection<QBRosterEntry> getUnfiledEntries()
```
    Returns an unmodifiable collection for the unfiled roster entries. An unfiled entry is an entry that doesn't belong to any groups.
    
    Returns:
    
    the unfiled roster entries.
  - getEntry
```
public QBRosterEntry getEntry(int userId)
```
    Returns the roster entry associated with the given user identifier or null if the user is not an entry in the roster.
    
    Returns:
    
    the roster entry or null if it does not exist.
  - contains
```
public boolean contains(int userId)
```
    Returns true if the specified user is an entry in the roster.
    
    Returns:
    
    true if the XMPP address is an entry in the roster.
  - getPresence
```
public QBPresence getPresence(int userId)
```
    Returns the presence info for a particular user. If the user is offline, or if no presence data is available (such as when you are not subscribed to the user's presence updates), unavailable presence will be returned.
    
    Parameters:
    
    userId - requested user identifier
    
    Returns:
    
    the user's current presence, or unavailable presence if the user is offline or if no presence information is available.
  - sendPresence
```
public void sendPresence(QBPresence presence)
                  throws SmackException.NotConnectedException
```
    Sends presence
    
    Parameters:
    
    presence - The instance of QBPresence
    
    Throws:
    
    SmackException.NotConnectedException
    
    See Also:
    
    QBPresence
  - sendPresence
```
public void sendPresence(QBPresence presence,
                         QBEntityCallback<java.lang.Void> callback)
```
  - addSubscriptionListener
```
public void addSubscriptionListener(QBSubscriptionListener listener)
```
    Adds the subscription listener
    
    Parameters:
    
    listener - The subscription listener to add
    
    See Also:
    
    QBSubscriptionListener
  - removeSubscriptionListener
```
public void removeSubscriptionListener(QBSubscriptionListener listener)
```
    Removes the subscription listener
    
    Parameters:
    
    listener - The subscription listener to remove
    
    See Also:
    
    QBSubscriptionListener
  - addRosterListener
```
public void addRosterListener(QBRosterListener listener)
```
    Adds a listener to this roster. The listener will be fired anytime one or more changes to the roster are pushed from the server.
    
    Parameters:
    
    listener - a roster listener.
    
    See Also:
    
    QBRosterListener
  - removeRosterListener
```
public void removeRosterListener(QBRosterListener listener)
```
    Removes roster listener
    
    Parameters:
    
    listener - a roster listener.
    
    See Also:
    
    QBRosterListener
  - confirmSubscription
```
public void confirmSubscription(int userId)
                         throws SmackException.NotConnectedException,
                                SmackException.NotLoggedInException,
                                XMPPException,
                                SmackException.NoResponseException
```
    Confirms subscription request.
    
    Parameters:
    
    userId - The ID of a user who requested subscription.
    
    Throws:
    
    SmackException.NotConnectedException
    
    SmackException.NotLoggedInException
    
    XMPPException
    
    SmackException.NoResponseException
  - confirmSubscription
```
public void confirmSubscription(int userId,
                                QBEntityCallback<java.lang.Void> callback)
```
  - subscribe
```
public void subscribe(int userId)
               throws SmackException.NotConnectedException
```
    Subscribes to user (adds to the contact list).
    
    Parameters:
    
    userId - requested user ID.
    
    Throws:
    
    SmackException.NotConnectedException
  - subscribe
```
public void subscribe(int userId,
                      QBEntityCallback<java.lang.Void> callback)
```
  - unsubscribe
```
public void unsubscribe(int userId)
                 throws SmackException.NotConnectedException
```
    Subscribes from user (removes from the contact list).
    
    Parameters:
    
    userId - requested user ID.
    
    Throws:
    
    SmackException.NotConnectedException
  - unsubscribe
```
public void unsubscribe(int userId,
                        QBEntityCallback<java.lang.Void> callback)
```
  - reject
```
public void reject(int userId)
            throws SmackException.NotConnectedException
```
    Rejects subscription request.
    
    Parameters:
    
    userId - The user ID to reject subscription request.
    
    Throws:
    
    SmackException.NotConnectedException
  - reject
```
public void reject(int userId,
                   QBEntityCallback<java.lang.Void> callback)
```
  - notifySuccessResult
```
protected void notifySuccessResult(QBEntityCallback callback)
```
  - notifyFailResult
```
protected void notifyFailResult(QBEntityCallback callback,
                                java.lang.String error)
```

Class QBRoster

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QBRoster

QBRoster

Method Detail

reload

getSubscriptionMode

setSubscriptionMode

createGroup

getGroup

getGroupCount

getGroups

createEntry

createEntry

removeEntry

removeEntry

getEntryCount

getEntries

getUnfiledEntryCount

getUnfiledEntries

getEntry

contains

getPresence

sendPresence

sendPresence

addSubscriptionListener

removeSubscriptionListener

addRosterListener

removeRosterListener

confirmSubscription

confirmSubscription

subscribe

subscribe

unsubscribe

unsubscribe

reject

reject

notifySuccessResult

notifyFailResult