public class QBUsers extends BaseService
Modifier and Type | Method and Description |
---|---|
static Performer<java.lang.Void> |
deleteByExternalId(java.lang.String externalId)
Delete the user by external ID.
|
static Performer<java.lang.Void> |
deleteUser(int userId)
Delete the user.
|
static Performer<java.util.ArrayList<QBAddressBookContact>> |
getAddressBook(java.lang.String udid)
Retrieve current user's address book.
|
static Performer<java.util.ArrayList<QBUser>> |
getRegisteredUsersFromAddressBook(java.lang.String udid,
boolean isCompact)
Retrieves registered users from address book
|
static Performer<QBUser> |
getUser(int id)
Retrieve user by ID.
|
static Performer<QBUser> |
getUserByEmail(java.lang.String email)
Retrieve user by email.
|
static Performer<QBUser> |
getUserByExternalId(java.lang.String externalId)
Retrieve user by external ID.
|
static Performer<QBUser> |
getUserByFacebookId(java.lang.String facebookId)
Retrieve user by Facebook ID.
|
static Performer<QBUser> |
getUserByLogin(java.lang.String login)
Retrieve user by login.
|
static Performer<QBUser> |
getUserByTwitterDigitsId(java.lang.String twitterDigitsId)
Retrieve user by Twitter Digits ID.
|
static Performer<QBUser> |
getUserByTwitterId(java.lang.String twitterId)
Retrieve user by Twitter ID.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsers(QBPagedRequestBuilder requestBuilder)
Retrieve users
|
static Performer<java.util.ArrayList<QBUser>> |
getUsers(QBPagedRequestBuilder requestBuilder,
Bundle bundle)
Retrieve users.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByEmails(java.util.Collection<java.lang.String> usersEmails,
QBPagedRequestBuilder requestBuilder)
Retrieve users with emails
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByEmails(java.util.Collection<java.lang.String> usersEmails,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with emails (synchronous).
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFacebookId(java.util.Collection<java.lang.String> usersFacebookIds,
QBPagedRequestBuilder requestBuilder)
Retrieve users with Facebook IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFacebookId(java.util.Collection<java.lang.String> usersFacebookIds,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with Facebook IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFilter(java.util.Collection<?> filterValue,
java.lang.String filter,
QBPagedRequestBuilder requestBuilder)
Retrieve users using filter
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFilter(java.util.Collection<?> filterValue,
java.lang.String filter,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users using filter.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFullName(java.lang.String fullName,
QBPagedRequestBuilder requestBuilder)
Retrieve users by fullname.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByFullName(java.lang.String fullName,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users by fullname.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByIDs(java.util.Collection<java.lang.Integer> usersIDs,
QBPagedRequestBuilder requestBuilder)
Retrieve users with IDs
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByIDs(java.util.Collection<java.lang.Integer> usersIDs,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByLogins(java.util.Collection<java.lang.String> usersLogins,
QBPagedRequestBuilder requestBuilder)
Retrieve users with logins
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByLogins(java.util.Collection<java.lang.String> usersLogins,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with logins.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByPhoneNumbers(java.util.Collection<java.lang.String> usersPhoneNumbers,
QBPagedRequestBuilder requestBuilder)
Retrieve users by phone numbers.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByPhoneNumbers(java.util.Collection<java.lang.String> usersPhoneNumbers,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users by phone numbers.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTags(java.util.Collection<java.lang.String> tags,
QBPagedRequestBuilder requestBuilder)
Retrieve users by tags.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTags(java.util.Collection<java.lang.String> tags,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users by tags.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTwitterDigitsId(java.util.Collection<java.lang.String> usersTwitterDigitsIds,
QBPagedRequestBuilder requestBuilder)
Retrieve users with Twitter Digits IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTwitterDigitsId(java.util.Collection<java.lang.String> usersTwitterDigitsIds,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with Twitter Digits IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTwitterId(java.util.Collection<java.lang.String> usersTwitterIds,
QBPagedRequestBuilder requestBuilder)
Retrieve users with Twitter IDs.
|
static Performer<java.util.ArrayList<QBUser>> |
getUsersByTwitterId(java.util.Collection<java.lang.String> usersTwitterIds,
QBPagedRequestBuilder requestBuilder,
Bundle returnedBundle)
Retrieve users with Twitter IDs.
|
static Performer<java.lang.Void> |
resetPassword(java.lang.String email)
Reset the password.
|
static Performer<QBUser> |
signIn(QBUser user)
Logs in a user
|
static Performer<QBUser> |
signIn(java.lang.String login,
java.lang.String password)
Logs in a user with login and password
|
static Performer<QBUser> |
signInByEmail(java.lang.String email,
java.lang.String password)
Logs in a user with email and password.
|
static Performer<QBUser> |
signInUsingFirebase(java.lang.String projectId,
java.lang.String accessToken)
Logs in a user with Firebase.
|
static Performer<QBUser> |
signInUsingSocialProvider(java.lang.String socialProvider,
java.lang.String accessToken,
java.lang.String accessTokenSecret)
Logs in a user with social provider.
|
static Performer<QBUser> |
signInUsingTwitterDigits(java.lang.String xAuthServiceProvider,
java.lang.String xVerifyCredentialsAuthorization)
Deprecated.
in version 3.3.5. Use
signInUsingFirebase(String, String) |
static Performer<java.lang.Void> |
signOut()
Logs out the currently logged in user session.
|
static Performer<QBUser> |
signUp(QBUser user)
Signs up a new user.
|
static Performer<QBUser> |
signUpSignInTask(QBUser user)
Signs up and sign in a new user.
|
static Performer<QBUser> |
updateUser(QBUser user)
Update the user.
|
static Performer<QBAddressBookResponse> |
uploadAddressBook(java.util.ArrayList<QBAddressBookContact> contacts,
java.lang.String udid,
boolean force)
Upload current user's address book.
|
createBaseService, createFromExistentToken, getBaseService, getToken, getTokenExpirationDate, resetCredentials, setToken, setTokenExpirationDate
public static Performer<QBUser> signIn(QBUser user)
user
- The user instance to log in with.public static Performer<QBUser> signIn(java.lang.String login, java.lang.String password)
login
- The user login to log in with.password
- The user password to log in with.public static Performer<QBUser> signInByEmail(java.lang.String email, java.lang.String password)
email
- The user email to log in with.password
- The user password to log in with.public static Performer<QBUser> signInUsingSocialProvider(java.lang.String socialProvider, java.lang.String accessToken, java.lang.String accessTokenSecret)
socialProvider
- The social provider to log in with. Use QBProvider class.accessToken
- The social provider access token.accessTokenSecret
- The social provider access token secret.@Deprecated public static Performer<QBUser> signInUsingTwitterDigits(java.lang.String xAuthServiceProvider, java.lang.String xVerifyCredentialsAuthorization)
signInUsingFirebase(String, String)
xAuthServiceProvider
- Value obtained from the Digits by key X-Auth-Service-Provider.xVerifyCredentialsAuthorization
- Value obtained from the Digits by key X-Verify-Credentials-Authorization.public static Performer<QBUser> signInUsingFirebase(java.lang.String projectId, java.lang.String accessToken)
projectId
- Project's id in Firebase developer console.accessToken
- Value obtained from the Firebase session.public static Performer<java.lang.Void> signOut()
public static Performer<QBUser> signUp(QBUser user)
user
- The user instance to sign up with.public static Performer<QBUser> signUpSignInTask(QBUser user)
user
- The user instance to sign up and sign in with.public static Performer<java.util.ArrayList<QBUser>> getUsers(QBPagedRequestBuilder requestBuilder)
requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsers(QBPagedRequestBuilder requestBuilder, Bundle bundle)
requestBuilder
- The builder to set pagination request parameters.bundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByIDs(java.util.Collection<java.lang.Integer> usersIDs, QBPagedRequestBuilder requestBuilder)
usersIDs
- The array of users ids.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByIDs(java.util.Collection<java.lang.Integer> usersIDs, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersIDs
- The array of users ids.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByFilter(java.util.Collection<?> filterValue, java.lang.String filter, QBPagedRequestBuilder requestBuilder)
filterValue
- The value for a filter.filter
- The filter to use.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByFilter(java.util.Collection<?> filterValue, java.lang.String filter, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
filterValue
- The value for a filter.filter
- The filter to use.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByEmails(java.util.Collection<java.lang.String> usersEmails, QBPagedRequestBuilder requestBuilder)
usersEmails
- The array of users emails.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByEmails(java.util.Collection<java.lang.String> usersEmails, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersEmails
- The array of users emails.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByLogins(java.util.Collection<java.lang.String> usersLogins, QBPagedRequestBuilder requestBuilder)
usersLogins
- The array of users logins.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByLogins(java.util.Collection<java.lang.String> usersLogins, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersLogins
- The array of users logins.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByFacebookId(java.util.Collection<java.lang.String> usersFacebookIds, QBPagedRequestBuilder requestBuilder)
usersFacebookIds
- The array of users Facebook IDs.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByFacebookId(java.util.Collection<java.lang.String> usersFacebookIds, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersFacebookIds
- The array of users Facebook IDs.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByTwitterId(java.util.Collection<java.lang.String> usersTwitterIds, QBPagedRequestBuilder requestBuilder)
usersTwitterIds
- The array of users Twitter IDs.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByTwitterId(java.util.Collection<java.lang.String> usersTwitterIds, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersTwitterIds
- The array of users Twitter IDs.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByTwitterDigitsId(java.util.Collection<java.lang.String> usersTwitterDigitsIds, QBPagedRequestBuilder requestBuilder)
usersTwitterDigitsIds
- The array of users Twitter Digits IDs.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByTwitterDigitsId(java.util.Collection<java.lang.String> usersTwitterDigitsIds, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersTwitterDigitsIds
- The array of users Twitter Digits IDs.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByFullName(java.lang.String fullName, QBPagedRequestBuilder requestBuilder)
fullName
- The fullname.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByFullName(java.lang.String fullName, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
fullName
- The fullname.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByTags(java.util.Collection<java.lang.String> tags, QBPagedRequestBuilder requestBuilder)
tags
- The array of users tags.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByTags(java.util.Collection<java.lang.String> tags, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
tags
- The array of users tags.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<java.util.ArrayList<QBUser>> getUsersByPhoneNumbers(java.util.Collection<java.lang.String> usersPhoneNumbers, QBPagedRequestBuilder requestBuilder)
usersPhoneNumbers
- The array of users phone numbers.requestBuilder
- The builder to set pagination request parameters.public static Performer<java.util.ArrayList<QBUser>> getUsersByPhoneNumbers(java.util.Collection<java.lang.String> usersPhoneNumbers, QBPagedRequestBuilder requestBuilder, Bundle returnedBundle)
usersPhoneNumbers
- The array of users phone numbers.requestBuilder
- The builder to set pagination request parameters.returnedBundle
- The bundle with response additional information.public static Performer<QBUser> getUser(int id)
id
- The ID of the user.public static Performer<QBUser> getUserByLogin(java.lang.String login)
login
- The login of a user.public static Performer<QBUser> getUserByFacebookId(java.lang.String facebookId)
facebookId
- The Facebook ID of a user.public static Performer<QBUser> getUserByTwitterId(java.lang.String twitterId)
twitterId
- The Twitter ID of a user.public static Performer<QBUser> getUserByTwitterDigitsId(java.lang.String twitterDigitsId)
twitterDigitsId
- The Twitter Digits ID of a user.public static Performer<QBUser> getUserByEmail(java.lang.String email)
email
- The email of a user.public static Performer<QBUser> getUserByExternalId(java.lang.String externalId)
externalId
- The external ID of a user.public static Performer<QBUser> updateUser(QBUser user)
user
- The user to update.public static Performer<java.lang.Void> deleteUser(int userId)
userId
- The user ID to delete.public static Performer<java.lang.Void> deleteByExternalId(java.lang.String externalId)
externalId
- The user external ID to delete.public static Performer<java.lang.Void> resetPassword(java.lang.String email)
email
- The email to send a reset instruction.public static Performer<java.util.ArrayList<QBAddressBookContact>> getAddressBook(java.lang.String udid)
udid
- The current user's device identifier. If specified all operations with address book will be in this context. Can be null.public static Performer<QBAddressBookResponse> uploadAddressBook(java.util.ArrayList<QBAddressBookContact> contacts, java.lang.String udid, boolean force)
contacts
- An array of contacts from address book to upload.udid
- The current user's device identifier. If specified all operations with address book will be in this context. Can be null.force
- Pass 'true' if you want to override completely an existent address book.public static Performer<java.util.ArrayList<QBUser>> getRegisteredUsersFromAddressBook(java.lang.String udid, boolean isCompact)
udid
- User's device identifier. If specified all operations will be in this context. Max length 64 symbols.isCompact
- if true - server will return only 'id' and 'phone' fields of QBUser. Otherwise - all QBUser's fields will be returned.