CocoaDocs.org - QBRequest Class Reference

Inherits from	NSObject
Declared in	QBRequest.h

Tasks

QBUsers Methods

+ usersWithSuccessBlock:errorBlock:
Retrieve all Users for current account (last 10 users)
+ usersForPage:successBlock:errorBlock:
Retrieve all Users for current account (with extended set of pagination parameters)
+ usersWithExtendedRequest:page:successBlock:errorBlock:
Retrieve all Users for current account with extended request
+ userWithID:successBlock:errorBlock:
Retrieve User by identifier
+ usersWithIDs:page:successBlock:errorBlock:
Retrieve users with ids (with extended set of pagination parameters)
+ userWithLogin:successBlock:errorBlock:
Retrieve User by login
+ usersWithLogins:successBlock:errorBlock:
Retrieve users with logins (max 10 users)
+ usersWithLogins:page:successBlock:errorBlock:
Retrieve users with logins (with extended set of pagination parameters)
+ usersWithFullName:successBlock:errorBlock:
Retrieve Users by full name for current account (last 10 users)
+ usersWithFullName:page:successBlock:errorBlock:
Retrieve Users by full name for current account (with extended set of pagination parameters)
+ usersWithTags:successBlock:errorBlock:
Retrieve Users by tags for current account (last 10 users)
+ usersWithTags:page:successBlock:errorBlock:
Retrieve Users by tags for current account (with extended set of pagination parameters)
+ usersWithPhoneNumbers:successBlock:errorBlock:
Retrieve users with phone numbers (max 10 users)
+ usersWithPhoneNumbers:page:successBlock:errorBlock:
Retrieve users with phone numbers (with extended set of pagination parameters)
+ userWithFacebookID:successBlock:errorBlock:
Retrieve User by Facebook ID
+ usersWithFacebookIDs:successBlock:errorBlock:
Retrieve users with facebook ids (max 10 users)
+ usersWithFacebookIDs:page:successBlock:errorBlock:
Retrieve users with facebook ids (with extended set of pagination parameters)
+ userWithTwitterID:successBlock:errorBlock:
Retrieve User by Twitter ID
+ usersWithTwitterIDs:successBlock:errorBlock:
Retrieve users with twitter ids (max 10 users)
+ usersWithTwitterIDs:page:successBlock:errorBlock:
Retrieve users with twitter ids (with extended set of pagination parameters)
+ userWithEmail:successBlock:errorBlock:
Retrieve User by Email
+ usersWithEmails:successBlock:errorBlock:
Retrieve users with email (max 10 users)
+ usersWithEmails:page:successBlock:errorBlock:
Retrieve users with email (with extended set of pagination parameters)
+ userWithExternalID:successBlock:errorBlock:
Retrieve User by External identifier
+ updateUser:successBlock:errorBlock:
Update User
+ updateCurrentUser:successBlock:errorBlock:
Update current session user.
+ deleteUserWithID:successBlock:errorBlock:
Delete User by identifier
+ deleteUserWithExternalID:successBlock:errorBlock:
Delete User by external identifier
+ resetUserPasswordWithEmail:successBlock:errorBlock:
Reset user’s password. User with this email will retrieve an email instruction for reset password.

Properties

body

@property (nonatomic, copy) NSData *body

canceled

@property (nonatomic, getter=isCancelled, readonly) BOOL canceled

completionBlock

@property (nonatomic, copy) QBRequestCompletionBlock completionBlock

encoding

@property (nonatomic) NSStringEncoding encoding

headers

@property (nonatomic, copy) NSDictionary *headers

operation

@property (nonatomic, weak) NSOperation *operation

parameters

@property (nonatomic, copy, readonly) NSDictionary *parameters

requestSerialisator

@property (nonatomic, strong) QBHTTPRequestSerialiser<QBRequestSerialisationProtocol> *requestSerialisator

responseSerialisators

@property (nonatomic, strong) NSArray *responseSerialisators

updateBlock

@property (nonatomic, copy) QBRequestStatusUpdateBlock updateBlock

Class Methods

TDownloadFileWithBlobID:successBlock:statusBlock:errorBlock:

+ (QBRequest *)TDownloadFileWithBlobID:(NSUInteger)blobID successBlock:(void ( ^ ) ( QBResponse *response , NSData *fileData ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Download File task. Contains 2 requests: Get Blob with ID, download file

Warning: Deprecated in QB iOS SDK 2.3: Use ‘downloadFileWithID:successBlock:statusBlock:errorBlock’ instead.

Parameters

blobID: Unique blob identifier, value of ID property of the QBCBlob instance.

successBlock: Block with response and fileData if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

TUpdateFileWithData:file:successBlock:statusBlock:errorBlock:

+ (QBRequest *)TUpdateFileWithData:(NSData *)data file:(QBCBlob *)file successBlock:(void ( ^ ) ( QBResponse *response ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Update File task. Contains 3 quieries: Update Blob, Upload file, Declaring file uploaded

Parameters

data: File to be uploaded

successBlock: Block with response if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

blob: File which needs to be updated

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

TUploadFile:fileName:contentType:isPublic:successBlock:statusBlock:errorBlock:

+ (QBRequest *)TUploadFile:(NSData *)data fileName:(NSString *)fileName contentType:(NSString *)contentType isPublic:(BOOL)isPublic successBlock:(void ( ^ ) ( QBResponse *response , QBCBlob *blob ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Upload File task. Contains 3 requests: Create Blob, upload file, declaring file uploaded

Parameters

data: File to be uploaded

fileName: Name of the file

contentType: Type of the content in mime format

isPublic: Blob’s visibility

successBlock: Block with response if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

blobObjectAccessWithBlobID:successBlock:errorBlock:

+ (QBRequest *)blobObjectAccessWithBlobID:(NSUInteger)blobID successBlock:(void ( ^ ) ( QBResponse *response , QBCBlobObjectAccess *objectAccess ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Get File by ID as BlobObjectAccess with read access

Parameters

blobID: Unique blob identifier, value of ID property of the QBCBlob instance.

successBlock: Block with response and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

blobWithID:successBlock:errorBlock:

+ (QBRequest *)blobWithID:(NSUInteger)blobID successBlock:(void ( ^ ) ( QBResponse *response , QBCBlob *blob ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve blob with ID.

Parameters

blobID: Unique blob identifier, value of ID property of the QBCBlob instance.

successBlock: Block with response and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

blobsForPage:successBlock:errorBlock:

+ (QBRequest *)blobsForPage:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *blobs ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Get list of blob for the current User (with extended set of pagination parameters)

Parameters

page: Page information

successBlock: Block with response, page and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

blobsWithSuccessBlock:errorBlock:

+ (QBRequest *)blobsWithSuccessBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *blobs ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Get list of blob for the current User (last 10 files)

Parameters

successBlock: Block with response, page and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

completeBlobWithID:size:successBlock:errorBlock:

+ (QBRequest *)completeBlobWithID:(NSUInteger)blobID size:(NSUInteger)size successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Declaring Blob uploaded with ID

Parameters

blobID: Unique blob identifier, value of ID property of the QBCBlob instance.

size: Size of uploaded file, in bytes

successBlock: Block with response and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

countObjectsWithClassName:extendedRequest:successBlock:errorBlock:

+ (QBRequest *)countObjectsWithClassName:(NSString *)className extendedRequest:(NSMutableDictionary *)extendedRequest successBlock:(void ( ^ ) ( QBResponse *response , NSUInteger count ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Count of objects with extended Request

Parameters

className: Name of class

extendedRequest: Extended set of request parameters

successBlock: Block with response instance and count of objects if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

countOfDialogsWithExtendedRequest:successBlock:errorBlock:

+ (QBRequest *)countOfDialogsWithExtendedRequest:(NSDictionary *)parameters successBlock:(void ( ^ ) ( QBResponse *response , NSUInteger count ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Returns count of dialogs.

Parameters

parameters: Dialogs filter parameters.

successBlock: Block with response instance and count if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

countOfMessagesForDialogID:extendedRequest:successBlock:errorBlock:

+ (QBRequest *)countOfMessagesForDialogID:(NSString *)dialogID extendedRequest:(NSDictionary *)parameters successBlock:(void ( ^ ) ( QBResponse *response , NSUInteger count ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Returns count of messages for dialog.

Parameters

dialogID: Dialog ID of the chat messages.

parameters: Messages filter parameters.

successBlock: Block with response instance and count if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

createBlob:successBlock:errorBlock:

+ (QBRequest *)createBlob:(QBCBlob *)blob successBlock:(void ( ^ ) ( QBResponse *response , QBCBlob *blob ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Create blob.

Parameters

blob: An instance of QBCBlob, describing the file to be uploaded.

successBlock: Block with response and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

createDialog:successBlock:errorBlock:

+ (QBRequest *)createDialog:(QBChatDialog *)dialog successBlock:(void ( ^ ) ( QBResponse *response , QBChatDialog *createdDialog ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create chat dialog

Parameters

dialog: chat dialog instance

successBlock: Block with response and created chat dialog instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

createEvent:successBlock:errorBlock:

+ (QBRequest *)createEvent:(QBMEvent *)event successBlock:(void ( ^ ) ( QBResponse *response , NSArray *events ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create an event

Parameters

event: An instance of QBMEvent to create

successBlock: Block with response and event instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

createGeoData:successBlock:errorBlock:

+ (QBRequest *)createGeoData:(QBLGeoData *)geoData successBlock:(void ( ^ ) ( QBResponse *response , QBLGeoData *geoData ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create geo data

Parameters

geoData: An instance of QBLGeoData

successBlock: Block with response and geodata instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

createMessage:successBlock:errorBlock:

+ (QBRequest *)createMessage:(QBChatMessage *)message successBlock:(void ( ^ ) ( QBResponse *response , QBChatMessage *createdMessage ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create chat message.

Parameters

message: Сhat message instance to create.

successBlock: Block with response and chat message instance if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

createObject:successBlock:errorBlock:

+ (QBRequest *)createObject:(QBCOCustomObject *)object successBlock:(void ( ^ ) ( QBResponse *response , QBCOCustomObject *object ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create record

Parameters

object: An instance of object that will be created

successBlock: Block with response instance and created object if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

createObjects:className:successBlock:errorBlock:

+ (QBRequest *)createObjects:(NSArray *)objects className:(NSString *)className successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create records

Parameters

objects: An array of instances of objects that will be created

className: Name of class

successBlock: Block with response instance, NSArray of created objects if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

createPlace:successBlock:errorBlock:

+ (QBRequest *)createPlace:(QBLPlace *)place successBlock:(void ( ^ ) ( QBResponse *response , QBLPlace *place ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create place

Warning: Deprecated in QB iOS SDK 2.3. The Places API along with associated documentation and code samples has been deprecated and is no longer maintained. We no longer provide support for this module, nor do we encourage its use in your project. We suggest that in order to achieve similar functionality, you use the Custom Objects module.

Parameters

place: An instance of QBLPlace

successBlock: Block with response and place instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

createPushToken:successBlock:errorBlock:

+ (QBRequest *)createPushToken:(QBMPushToken *)pushToken successBlock:(void ( ^ ) ( QBResponse *response , QBMPushToken *token ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create push token

Warning: Deprecated in 2.3. Use ‘+[QBRequest createSubscription:successBlock:errorBlock:’ instead.

Parameters

pushToken: An instance of QBMPushToken

successBlock: Block with response and token instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

createSessionWithExtendedParameters:successBlock:errorBlock:

+ (QBRequest *)createSessionWithExtendedParameters:(QBSessionParameters *)extendedParameters successBlock:(void ( ^ ) ( QBResponse *response , QBASession *session ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Session Creation with extended parameters

Warning: Deprecated in QB iOS SDK 2.4. Session is created and updated automatically by Quickblox SDK.

Parameters

extendedParameters: Additional parameters to create a session

successBlock: Block with response and session instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

createSessionWithSuccessBlock:errorBlock:

+ (QBRequest *)createSessionWithSuccessBlock:(void ( ^ ) ( QBResponse *response , QBASession *session ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Session Creation

Warning: Deprecated in QB iOS SDK 2.4. Session is created and updated automatically by Quickblox SDK.

Parameters

successBlock: Block with response and session instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

createSubscription:successBlock:errorBlock:

+ (QBRequest *)createSubscription:(QBMSubscription *)subscription successBlock:(void ( ^ ) ( QBResponse *, NSArray *))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Create subscription

Parameters

successBlock: Block with response and subscriber instances if request succeded

errorBlock: Block with response instance if request failed

subscriber: An instance of QBMSubscription

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

deleteBlobWithID:successBlock:errorBlock:

+ (QBRequest *)deleteBlobWithID:(NSUInteger)blobID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Delete Blob

Parameters

blobID: Unique blob identifier, value of ID property of the QBCBlob instance.

successBlock: Block with response if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

deleteDialogWithID:successBlock:errorBlock:

+ (QBRequest *)deleteDialogWithID:(NSString *)dialogID successBlock:(void ( ^ ) ( QBResponse *responce ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete a dialog.

Warning: Deprecated in 2.4.3. Use ‘deleteDialogsWithIDs:forAllUsers:successBlock:errorBlock:’ instead.

Parameters

successBlock: Block with response if request succeded

errorBlock: Block with response instance if request failed

dialogID.: The ID of a dialog to delete

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

deleteDialogsWithIDs:forAllUsers:successBlock:errorBlock:

+ (QBRequest *)deleteDialogsWithIDs:(NSSet *)dialogIDs forAllUsers:(BOOL)forAllUsers successBlock:(void ( ^ ) ( QBResponse *response , NSArray *deletedObjectsIDs , NSArray *notFoundObjectsIDs , NSArray *wrongPermissionsObjectsIDs ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete dialogs

Passing YES to ‘forAllUsers’ requires current user to be owner of the dialog! If current user is not the owner - request fails.

Parameters

successBlock: Block with response if request succeded.

errorBlock: Block with response instance if request failed.

dialogIDs.: The IDs of a dialogs to delete.

forAllUsers.: Delete dialog for current user or remove it for all users.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

deleteEventWithID:successBlock:errorBlock:

+ (QBRequest *)deleteEventWithID:(NSUInteger)ID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get an event with ID

Parameters

ID: ID of QBMEvent to be deleted.

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

deleteFileFromClassName:objectID:fileFieldName:successBlock:errorBlock:

+ (QBRequest *)deleteFileFromClassName:(NSString *)className objectID:(NSString *)objectID fileFieldName:(NSString *)fileFieldName successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete file

Parameters

className: Name of class

objectID: Identifier of object form which file will be deleted

fileFieldName: Name of file field

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

statusBlock: Block with upload/download progress

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

deleteGeoDataWithID:successBlock:errorBlock:

+ (QBRequest *)deleteGeoDataWithID:(NSUInteger)geodataID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete geo data by ID

Parameters

geodataID: ID of instance of QBLGeoData that will be deleted

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

deleteGeoDataWithRemainingDays:successBlock:errorBlock:

+ (QBRequest *)deleteGeoDataWithRemainingDays:(NSUInteger)days successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete geo data with remaining days

Parameters

days: Maximum age of data that must remain in the database after a query.

successBlock: Block with response instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

deleteMessageWithID:successBlock:errorBlock:

+ (QBRequest *)deleteMessageWithID:(NSString *)messageID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete existing chat message for current user.

Warning: Deprecated in 2.4.3. Use ‘deleteDialogsWithIDs:forAllUsers:successBlock:errorBlock:’ instead.

Parameters

messageID: Message ID to delete.

successBlock: Block with response instance if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

deleteMessagesWithIDs:forAllUsers:successBlock:errorBlock:

+ (QBRequest *)deleteMessagesWithIDs:(NSSet *)messageIDs forAllUsers:(BOOL)forAllUsers successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete messages.

Passing YES to ‘forAllUsers’ requires current user to be owner of the message! If current user is not the owner - request fails.

Parameters

successBlock: Block with response instance if request succeded.

errorBlock: Block with response instance if request failed.

messageIDs.: The IDs of a messages to delete.

forAllUsers.: Delete message for current user or remove it for all users.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

deleteObjectWithID:className:successBlock:errorBlock:

+ (QBRequest *)deleteObjectWithID:(NSString *)objectID className:(NSString *)className successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete object by identifier

Parameters

objectID: ID of object to be removed.

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

deleteObjectsWithIDs:className:successBlock:errorBlock:

+ (QBRequest *)deleteObjectsWithIDs:(NSArray *)objectsIDs className:(NSString *)className successBlock:(void ( ^ ) ( QBResponse *response , NSArray *deletedObjectsIDs , NSArray *notFoundObjectsIDs , NSArray *wrongPermissionsObjectsIDs ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete objects by IDs

Parameters

objectsIDs: Array of IDs of objects to be removed.

successBlock: Block with response instance, NSArray of deleted objects Ids and NSArray of not found objects Ids if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

deletePlaceWithID:successBlock:errorBlock:

+ (QBRequest *)deletePlaceWithID:(NSUInteger)placeID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete place with ID

Parameters

placeID: ID of instance of QBLPlace that will be deleted

successBlock: Block with response instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

deletePushTokenWithID:successBlock:errorBlock:

+ (QBRequest *)deletePushTokenWithID:(NSUInteger)ID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete push token with ID

Warning: Deprecated in 2.3. Use ‘+[QBRequest deleteSubscriptionWithID:successBlock:errorBlock:’ instead

Parameters

ID: Identifier of push token to delete

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

deleteSubscriptionWithID:successBlock:errorBlock:

+ (QBRequest *)deleteSubscriptionWithID:(NSUInteger)ID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Delete subscription with ID

Parameters

ID: An ID of instance of QBMSubscription that will be deleted

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

deleteUserWithExternalID:successBlock:errorBlock:

+ (QBRequest *)deleteUserWithExternalID:(NSUInteger)userExternalID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Delete User by external identifier

Parameters

userExternalID: External ID of user to be removed.

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

deleteUserWithID:successBlock:errorBlock:

+ (QBRequest *)deleteUserWithID:(NSUInteger)userID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Delete User by identifier

Parameters

userID: ID of user to be removed.

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

destroySessionWithSuccessBlock:errorBlock:

+ (QBRequest *)destroySessionWithSuccessBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Session Destroy

Parameters

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

dialogsForPage:extendedRequest:successBlock:errorBlock:

+ (QBRequest *)dialogsForPage:(QBResponsePage *)page extendedRequest:(NSDictionary *)extendedRequest successBlock:(void ( ^ ) ( QBResponse *response , NSArray *dialogObjects , NSSet *dialogsUsersIDs , QBResponsePage *page ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve chat dialogs for page

Parameters

page: Page with skip and limit

successBlock: Block with response instance, arrays of chat dialogs and chat dialogs users IDs and page instance if request succeded

errorBlock: Block with response instance if request failed

extendedParameters: Set of request parameters

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

dialogsWithSuccessBlock:errorBlock:

+ (QBRequest *)dialogsWithSuccessBlock:(void ( ^ ) ( QBResponse *response , NSArray *dialogObjects , NSSet *dialogsUsersIDs ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve chat dialogs

Parameters

successBlock: Block with response instance and arrays of chat dialogs and chat dialogs users IDs if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

downloadFileFromClassName:objectID:fileFieldName:successBlock:statusBlock:errorBlock:

+ (QBRequest *)downloadFileFromClassName:(NSString *)className objectID:(NSString *)objectID fileFieldName:(NSString *)fileFieldName successBlock:(void ( ^ ) ( QBResponse *response , NSData *loadedData ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Download file

Parameters

className: Name of class

objectID: Identifier of object which file will be downloaded

fileFieldName: Name of file field

successBlock: Block with response instance and NSData instance if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

downloadFileWithID:successBlock:statusBlock:errorBlock:

+ (QBRequest *)downloadFileWithID:(NSUInteger)fileID successBlock:(void ( ^ ) ( QBResponse *response , NSData *fileData ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Download File by file identifier.

Parameters

fileID: File identifier.

successBlock: Block with response and fileData if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

downloadFileWithUID:successBlock:statusBlock:errorBlock:

+ (QBRequest *)downloadFileWithUID:(NSString *)UID successBlock:(void ( ^ ) ( QBResponse *response , NSData *fileData ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Download file

Parameters

UID: File unique identifier, value of UID property of the QBCBlob instance.

successBlock: Block with response if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

eventWithID:successBlock:errorBlock:

+ (QBRequest *)eventWithID:(NSUInteger)ID successBlock:(void ( ^ ) ( QBResponse *response , QBMEvent *event ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get an event with ID

Parameters

ID: ID of QBMEvent to be retrieved.

successBlock: Block with response and event instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

eventsForPage:successBlock:errorBlock:

+ (QBRequest *)eventsForPage:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *events ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve all events which were created by current user (with extended set of pagination parameters)

Parameters

page: Configured QBLGeneralResponsePage instance

successBlock: Block with response, page, events instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

geoDataWithFilter:page:successBlock:errorBlock:

+ (QBRequest *)geoDataWithFilter:(QBLGeoDataFilter *)filter page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects , QBGeneralResponsePage *page ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get multiple geo data

Parameters

filter: QBLGeoDataFilter with filter values set

page: Requested page

successBlock: Block with response instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

geoDataWithId:successBlock:errorBlock:

+ (QBRequest *)geoDataWithId:(NSUInteger)geoDataId successBlock:(void ( ^ ) ( QBResponse *response , QBLGeoData *geoData ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get geo data by ID

Parameters

geoDataId: ID of instance of QBLGeoData that will be retrieved

successBlock: Block with response and geodata instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

logInWithSocialProvider:accessToken:accessTokenSecret:successBlock:errorBlock:

+ (QBRequest *)logInWithSocialProvider:(NSString *)provider accessToken:(NSString *)accessToken accessTokenSecret:(NSString *)accessTokenSecret successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

User LogIn with social provider’s token

Parameters

provider: Social provider. Posible values: facebook, twitter.

accessToken: Social provider access token.

accessTokenSecret: Social provider access token secret.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

logInWithSocialProvider:scope:successBlock:errorBlock:

+ (QBRequest *)logInWithSocialProvider:(NSString *)provider scope:(NSArray *)scope successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

User LogIn with social provider

Warning: Deprecated in 2.4. Use ‘+[QBRequest logInWithSocialProvider:accessToken:accessTokenSecret:successBlock:errorBlock:’ instead.‘ instead.

Parameters

provider: Social provider. Posible values: facebook, twitter.

scope: Permission. Permissions for choosen provider. Should not be nil.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

logInWithUserEmail:password:successBlock:errorBlock:

+ (QBRequest *)logInWithUserEmail:(NSString *)email password:(NSString *)password successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

User LogIn with email

Parameters

email: Email of QBUUser which authenticates.

password: Password of QBUUser which authenticates.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

logInWithUserLogin:password:successBlock:errorBlock:

+ (QBRequest *)logInWithUserLogin:(NSString *)login password:(NSString *)password successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

User LogIn with login

Parameters

login: Login of QBUUser which authenticates.

password: Password of QBUUser which authenticates.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

logOutWithSuccessBlock:errorBlock:

+ (QBRequest *)logOutWithSuccessBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

LogOut current user

Parameters

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBAuth.h

markMessagesAsRead:dialogID:successBlock:errorBlock:

+ (QBRequest *)markMessagesAsRead:(NSSet *)messagesIDs dialogID:(NSString *)dialogID successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Mark messages as read.

Parameters

dialogID: dialog ID.

successBlock: Block with response instance if request succeded.

errorBlock: Block with response instance if request failed.

messageIDs: Set of chat message IDs to mark as read. If messageIDs is nil then all messages in dialog will be marked as read.

Return Value

An instance, which conforms Cancelable protocol. Use this instance to cancel the operation.

Declared In

QBRequest+QBChat.h

messagesWithDialogID:extendedRequest:forPage:successBlock:errorBlock:

+ (QBRequest *)messagesWithDialogID:(NSString *)dialogID extendedRequest:(NSDictionary *)extendedParameters forPage:(QBResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *, NSArray *, QBResponsePage *))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve chat messages within particular dialog for page.

By default all messages retrieved from server is marked as read, if you need another behaviour please use mark_as_read parameter in extendedParameters dictionary.

@code [extendedParameters setObject:@“0” forKey:@“mark_as_read”]; @endcode

Parameters

dialogID: ID of a dialog.

extendedParameters: A set of additional request parameters.

page: response page instance.

successBlock: Block with response instance and array of chat messages for page if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

messagesWithDialogID:successBlock:errorBlock:

+ (QBRequest *)messagesWithDialogID:(NSString *)dialogID successBlock:(void ( ^ ) ( QBResponse *response , NSArray *messages ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve first 100 chat messages within particular dialog

Parameters

dialogID: ID of a dialog

successBlock: Block with response instance and array of chat messages if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

objectWithClassName:ID:successBlock:errorBlock:

+ (QBRequest *)objectWithClassName:(NSString *)className ID:(NSString *)ID successBlock:(void ( ^ ) ( QBResponse *response , QBCOCustomObject *object ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve object with ID

Parameters

className: Name of class

ID: Identifier of object to be retrieved

successBlock: Block with response instance and QBCOCustomObject instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

objectsWithClassName:IDs:successBlock:errorBlock:

+ (QBRequest *)objectsWithClassName:(NSString *)className IDs:(NSArray *)IDs successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve objects with IDs

Parameters

className: Name of class

IDs: Identifiers of objects to be retrieved

successBlock: Block with response instance, NSArray of found objects if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

objectsWithClassName:aggregationOperator:forFieldName:groupByFieldName:extendedRequest:successBlock:errorBlock:

+ (QBRequest *)objectsWithClassName:(NSString *)className aggregationOperator:(QBCOAggregationOperator)aggregationOperator forFieldName:(NSString *)fieldName groupByFieldName:(NSString *)groupFieldName extendedRequest:(NSMutableDictionary *)extendedRequest successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects , QBResponsePage *responsePage ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Returns calculated data for specified objects

Parameters

className: Required. Name of class.

aggregationOperator: Required. Maximum, minimum, average or summary.

fieldName: Required. Field name which will be used for calculation.

groupFieldName: Required. Field name for group.

extendedRequest: Optional. Extended set of request parameters. count parameter is ignored. To receive count use countObjectsWithClassName:extendedRequest:successBlock:errorBlock:.

successBlock: Block with response instance, NSArray of grouped objects.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

objectsWithClassName:extendedRequest:successBlock:errorBlock:

+ (QBRequest *)objectsWithClassName:(NSString *)className extendedRequest:(NSMutableDictionary *)extendedRequest successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects , QBResponsePage *page ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve objects with extended Request

Parameters

className: Name of class

extendedRequest: Extended set of request parameters. count parameter is ignored. To receive count use countObjectsWithClassName:extendedRequest:successBlock:errorBlock:

successBlock: Block with response instance, NSArray of found objects, NSArray of not found objects Ids and QBResponsePage if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

objectsWithClassName:successBlock:errorBlock:

+ (QBRequest *)objectsWithClassName:(NSString *)className successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve objects

Parameters

className: Name of class

successBlock: Block with response instance, NSArray of found objects, NSArray of not found objects Ids and QBResponsePage if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

permissionsForObjectWithClassName:ID:successBlock:errorBlock:

+ (QBRequest *)permissionsForObjectWithClassName:(NSString *)className ID:(NSString *)ID successBlock:(void ( ^ ) ( QBResponse *response , QBCOPermissions *permissions ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve permissions for object with ID

Parameters

className: Name of class

ID: Identifier of object which permissions will be retrieved

successBlock: Block with response instance and QBCOPermissions instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

placeWithID:successBlock:errorBlock:

+ (QBRequest *)placeWithID:(NSUInteger)placeID successBlock:(void ( ^ ) ( QBResponse *response , QBLPlace *place ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get place with ID

Parameters

placeID: ID of instance of QBLPlace that will be retrieved

successBlock: Block with response and place instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

placesForPage:successBlock:errorBlock:

+ (QBRequest *)placesForPage:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects , QBGeneralResponsePage *page ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Get places with paged request

Parameters

page: Requested page

successBlock: Block with response instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

registerSubscriptionForDeviceToken:successBlock:errorBlock:

+ (QBRequest *)registerSubscriptionForDeviceToken:(NSData *)deviceToken successBlock:(void ( ^ ) ( QBResponse *response , NSArray *subscriptions ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Warning: Deprecated in 2.3. Use ‘+[QBRequest registerSubscriptionForDeviceToken:uniqueDeviceIdentifier:successBlock:errorBlock:’ instead.

Parameters

successBlock: Block with response and subscriber instances if request succeded

errorBlock: Block with response instance if request failed

subscriber: An instance of QBMSubscription

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

registerSubscriptionForDeviceToken:uniqueDeviceIdentifier:successBlock:errorBlock:

+ (QBRequest *)registerSubscriptionForDeviceToken:(NSData *)deviceToken uniqueDeviceIdentifier:(NSString *)uniqueDeviceIdentifier successBlock:(void ( ^ ) ( QBResponse *response , NSArray *subscriptions ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Create subscription for current device with custom UDID. This method registers push token on the server if they are not registered yet, then creates a Subscription and associates it with curent User.

Parameters

deviceToken: Token received from application:didRegisterForRemoteNotificationsWithDeviceToken: method

uniqueDeviceIdentifier: The device unique identifier

successBlock: Block with response and subscriptions instances if request succeded

errorBlock: Block with response error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

resetUserPasswordWithEmail:successBlock:errorBlock:

+ (QBRequest *)resetUserPasswordWithEmail:(NSString *)email successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Reset user’s password. User with this email will retrieve an email instruction for reset password.

Parameters

email: User’s email

successBlock: Block with response instance if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

sendPush:toUsers:successBlock:errorBlock:

+ (QBRequest *)sendPush:(QBMPushMessage *)pushMessage toUsers:(NSString *)usersIDs successBlock:(void ( ^ ) ( QBResponse *response , QBMEvent *event ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Send Apple based push notification to users

Parameters

pushMessage: Composed push message to send

usersIDs: Users identifiers who will get the message. Contain a string of users ids divided by comas.

successBlock: Block with response and event instances if request succeded

errorBlock: Block with error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

sendPush:toUsersWithAnyOfTheseTags:successBlock:errorBlock:

+ (QBRequest *)sendPush:(QBMPushMessage *)pushMessage toUsersWithAnyOfTheseTags:(NSString *)usersTags successBlock:(void ( ^ ) ( QBResponse *response , QBMEvent *event ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Send Apple based push notification to users with tags

Parameters

pushMessage: composed push message to send

usersTags: users tags who will get the message. Contain a string of users tags divided by comas.

successBlock: Block with response and event instances if request succeded

errorBlock: Block with error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

sendPushWithText:toUsers:successBlock:errorBlock:

+ (QBRequest *)sendPushWithText:(NSString *)text toUsers:(NSString *)usersIDs successBlock:(void ( ^ ) ( QBResponse *response , NSArray *events ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Send simple push notification to users

Parameters

text: composed push notification’s text to send

usersIDs: users identifiers who will get the message. Contain a string of users ids divided by comas.

successBlock: Block with response and event instances if request succeded

errorBlock: Block with error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

sendPushWithText:toUsersWithAnyOfTheseTags:successBlock:errorBlock:

+ (QBRequest *)sendPushWithText:(NSString *)text toUsersWithAnyOfTheseTags:(NSString *)usersTags successBlock:(void ( ^ ) ( QBResponse *response , NSArray *events ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Send simple push notification to users with tags

Parameters

text: composed push notification’s text to send

usersTags: users tags who will get the message. Contain a string of users tags divided by comas.

successBlock: Block with response and token instances if request succeded

errorBlock: Block with response instance and QBMEvent instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

signUp:successBlock:errorBlock:

+ (QBRequest *)signUp:(QBUUser *)user successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

User sign up

Parameters

user: User to signup

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest. Use this instance to cancel the operation.

Declared In

QBRequest+QBAuth.h

subscriptionsWithSuccessBlock:errorBlock:

+ (QBRequest *)subscriptionsWithSuccessBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Retrieve all subscriptions

Parameters

successBlock: Block with response and subscribers instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

taggedBlobsForPage:successBlock:errorBlock:

+ (QBRequest *)taggedBlobsForPage:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *blobs ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Get list of tagged blobs for the current User (with extended set of pagination parameters)

Parameters

page: Page information

successBlock: Block with response, page and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

taggedBlobsWithSuccessBlock:errorBlock:

+ (QBRequest *)taggedBlobsWithSuccessBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *blobs ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Get list of tagged blobs for the current User (last 10 files)

Parameters

successBlock: Block with response, page and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

totalUnreadMessageCountForDialogsWithIDs:successBlock:errorBlock:

+ (QBRequest *)totalUnreadMessageCountForDialogsWithIDs:(NSSet *)dialogIDs successBlock:(void ( ^ ) ( QBResponse *response , NSUInteger count , NSDictionary *dialogs ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Returns unread message count for dialogs with ids. Includes total count for all dialogs for user also.

Parameters

dialogIDs: Array of dialog IDs.

successBlock: Block with response instance total unread count and dialogs dictionary.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

unregisterSubscriptionForUniqueDeviceIdentifier:successBlock:errorBlock:

+ (QBRequest *)unregisterSubscriptionForUniqueDeviceIdentifier:(NSString *)uniqueDeviceIdentifier successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Remove subscription for a specific device. This method remove subscription for a specific device.

Parameters

uniqueDeviceIdentifier: The device unique identifier

successBlock: Block with response instance if request succeded

errorBlock: Block with error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

unregisterSubscriptionWithSuccessBlock:errorBlock:

+ (QBRequest *)unregisterSubscriptionWithSuccessBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(void ( ^ ) ( QBError *error ))errorBlock

Discussion

Remove subscription for current device.

Warning: Deprecated in 2.3. Use ‘+[QBRequest unregisterSubscriptionForUniqueDeviceIdentifier:successBlock:errorBlock:’ instead.

This method remove subscription for current device.

Parameters

successBlock: Block with response instance if request succeded

errorBlock: Block with error if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

updateBlob:successBlock:errorBlock:

+ (QBRequest *)updateBlob:(QBCBlob *)blob successBlock:(void ( ^ ) ( QBResponse *response , QBCBlob *blob ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Update Blob

Parameters

blob: An instance of QBCBlob to be updated.

successBlock: Block with response and blob instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

updateCurrentUser:successBlock:errorBlock:

+ (QBRequest *)updateCurrentUser:(QBUpdateUserParameters *)parameters successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Update current session user.

Parameters

parameters: User parameters that could be updated.

successBlock: Block with response and user instances if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

updateDialog:successBlock:errorBlock:

+ (QBRequest *)updateDialog:(QBChatDialog *)dialog successBlock:(void ( ^ ) ( QBResponse *, QBChatDialog *))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update existing chat dialog

Parameters

successBlock: Block with response and updated chat dialog instances if request succeded

errorBlock: Block with response instance if request failed

dialog.: The dialog instance to update

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

updateEvent:successBlock:errorBlock:

+ (QBRequest *)updateEvent:(QBMEvent *)event successBlock:(void ( ^ ) ( QBResponse *response , QBMEvent *event ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update an event

Parameters

event: An instance of QBMEvent to update

successBlock: Block with response and event instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBPushNotifications.h

updateGeoData:successBlock:errorBlock:

+ (QBRequest *)updateGeoData:(QBLGeoData *)geodata successBlock:(void ( ^ ) ( QBResponse *response , QBLGeoData *geoData ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update geo data

Parameters

geodata: An instance of QBLGeoData

successBlock: Block with response and geodata instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

updateMessage:successBlock:errorBlock:

+ (QBRequest *)updateMessage:(QBChatMessage *)message successBlock:(void ( ^ ) ( QBResponse *response ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update existing chat message - mark it as read.

Parameters

message: Сhat message to update.

successBlock: Block with response instance if request succeded.

errorBlock: Block with response instance if request failed.

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBChat.h

updateObject:specialUpdateOperators:successBlock:errorBlock:

+ (QBRequest *)updateObject:(QBCOCustomObject *)object specialUpdateOperators:(NSMutableDictionary *)specialUpdateOperators successBlock:(void ( ^ ) ( QBResponse *response , QBCOCustomObject *object ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update record with Special update operators

Parameters

object: An instance of object that will be updated

specialUpdateOperators: Special update operators http://quickblox.com/developers/SimpleSample-customObjects-ios#Special_update_oparators

successBlock: Block with response instance and updated object if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

updateObject:successBlock:errorBlock:

+ (QBRequest *)updateObject:(QBCOCustomObject *)object successBlock:(void ( ^ ) ( QBResponse *response , QBCOCustomObject *object ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update record

Parameters

object: An instance of object that will be updated

successBlock: Block with response instance and updated object if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

updateObjects:className:successBlock:errorBlock:

+ (QBRequest *)updateObjects:(NSArray *)objects className:(NSString *)className successBlock:(void ( ^ ) ( QBResponse *response , NSArray *objects , NSArray *notFoundObjectsIds ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update records

Parameters

objects: An array of instances of objects that will be updated

className: Name of class

successBlock: Block with response instance, updated objects and not found objects Ids if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

updatePlace:successBlock:errorBlock:

+ (QBRequest *)updatePlace:(QBLPlace *)place successBlock:(void ( ^ ) ( QBResponse *response , QBLPlace *place ))successBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Update place

Parameters

place: An instance of QBLPlace

successBlock: Block with response and place instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBLocation.h

updateUser:successBlock:errorBlock:

+ (QBRequest *)updateUser:(QBUUser *)user successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Update User

Warning: Deprecated in QB iOS SDK 2.3. Use ‘updateCurrentUser:successBlock:errorBlock:’ instead.

Parameters

user: An instance of QBUUser, describing the user to be edited.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

uploadFile:blobWithWriteAccess:successBlock:statusBlock:errorBlock:

+ (QBRequest *)uploadFile:(NSData *)data blobWithWriteAccess:(QBCBlob *)blobWithWriteAccess successBlock:(void ( ^ ) ( QBResponse *response ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Upload file using BlobObjectAccess

Parameters

data: File

blobWithWriteAccess: An instance of QBCBlobObjectAccess

successBlock: Block with response if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBContent.h

uploadFile:className:objectID:fileFieldName:successBlock:statusBlock:errorBlock:

+ (QBRequest *)uploadFile:(QBCOFile *)file className:(NSString *)className objectID:(NSString *)objectID fileFieldName:(NSString *)fileFieldName successBlock:(void ( ^ ) ( QBResponse *response , QBCOFileUploadInfo *info ))successBlock statusBlock:(QBRequestStatusUpdateBlock)statusBlock errorBlock:(QBRequestErrorBlock)errorBlock

Discussion

Upload file

Parameters

file: File

className: Name of class

objectID: Identifier of object to which file will be uploaded

fileFieldName: Name of file field

successBlock: Block with response instance if request succeded

statusBlock: Block with upload/download progress

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBCustomObjects.h

userWithEmail:successBlock:errorBlock:

+ (QBRequest *)userWithEmail:(NSString *)userEmail successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by Email

Parameters

userEmail: Email of user to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

userWithExternalID:successBlock:errorBlock:

+ (QBRequest *)userWithExternalID:(NSUInteger)userExternalID successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by External identifier

Parameters

userExternalID: External ID of user to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

userWithFacebookID:successBlock:errorBlock:

+ (QBRequest *)userWithFacebookID:(NSString *)userFacebookID successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by Facebook ID

Parameters

userFacebookID: Facebook ID of user to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

userWithID:successBlock:errorBlock:

+ (QBRequest *)userWithID:(NSUInteger)userID successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by identifier

Parameters

userID: ID of QBUUser to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

userWithLogin:successBlock:errorBlock:

+ (QBRequest *)userWithLogin:(NSString *)userLogin successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by login

Parameters

userLogin: Login of user to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

userWithTwitterID:successBlock:errorBlock:

+ (QBRequest *)userWithTwitterID:(NSString *)userTwitterID successBlock:(void ( ^ ) ( QBResponse *response , QBUUser *user ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve User by Twitter ID

Parameters

userTwitterID: Twitter ID of user to be retrieved.

successBlock: Block with response and user instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersForPage:successBlock:errorBlock:

+ (QBRequest *)usersForPage:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve all Users for current account (with extended set of pagination parameters)

Parameters

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithEmails:page:successBlock:errorBlock:

+ (QBRequest *)usersWithEmails:(NSArray *)emails page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with email (with extended set of pagination parameters)

Parameters

emails: Emails of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithEmails:successBlock:errorBlock:

+ (QBRequest *)usersWithEmails:(NSArray *)emails successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with email (max 10 users)

Parameters

emails: Emails of users which you want to retrieve

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithExtendedRequest:page:successBlock:errorBlock:

+ (QBRequest *)usersWithExtendedRequest:(NSDictionary *)extendedRequest page:(QBGeneralResponsePage *)responsePage successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve all Users for current account with extended request

Parameters

extendedRequest: Dictionary with extended request

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

page: Pagination parameters

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithFacebookIDs:page:successBlock:errorBlock:

+ (QBRequest *)usersWithFacebookIDs:(NSArray *)facebookIDs page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with facebook ids (with extended set of pagination parameters)

Parameters

facebookIDs: Facebook IDs of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithFacebookIDs:successBlock:errorBlock:

+ (QBRequest *)usersWithFacebookIDs:(NSArray *)facebookIDs successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with facebook ids (max 10 users)

Parameters

facebookIDs: Facebook IDs of users which you want to retrieve

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithFullName:page:successBlock:errorBlock:

+ (QBRequest *)usersWithFullName:(NSString *)userFullName page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve Users by full name for current account (with extended set of pagination parameters)

Parameters

userFullName: Full name of users to be retrieved.

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithFullName:successBlock:errorBlock:

+ (QBRequest *)usersWithFullName:(NSString *)userFullName successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve Users by full name for current account (last 10 users)

Parameters

userFullName: Full name of users to be retrieved.

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithIDs:page:successBlock:errorBlock:

+ (QBRequest *)usersWithIDs:(NSArray *)IDs page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *))errorBlock

Discussion

Retrieve users with ids (with extended set of pagination parameters)

Parameters

IDs: IDs of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithLogins:page:successBlock:errorBlock:

+ (QBRequest *)usersWithLogins:(NSArray *)logins page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with logins (with extended set of pagination parameters)

Parameters

logins: Logins of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithLogins:successBlock:errorBlock:

+ (QBRequest *)usersWithLogins:(NSArray *)logins successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with logins (max 10 users)

Parameters

logins: Logins of users which you want to retrieve

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithPhoneNumbers:page:successBlock:errorBlock:

+ (QBRequest *)usersWithPhoneNumbers:(NSArray *)phoneNumbers page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with phone numbers (with extended set of pagination parameters)

Parameters

phoneNumbers: Pnone numbers of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithPhoneNumbers:successBlock:errorBlock:

+ (QBRequest *)usersWithPhoneNumbers:(NSArray *)phoneNumbers successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with phone numbers (max 10 users)

Parameters

phoneNumbers: Pnone numbers of users which you want to retrieve

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest. Use this instance to cancel the operation.

Declared In

QBRequest+QBUsers.h

usersWithSuccessBlock:errorBlock:

+ (QBRequest *)usersWithSuccessBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve all Users for current account (last 10 users)

Parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithTags:page:successBlock:errorBlock:

+ (QBRequest *)usersWithTags:(NSArray *)tags page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve Users by tags for current account (with extended set of pagination parameters)

Parameters

tags: Tags of users to be retrieved.

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithTags:successBlock:errorBlock:

+ (QBRequest *)usersWithTags:(NSArray *)tags successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve Users by tags for current account (last 10 users)

Parameters

tags: Tags of users to be retrieved.

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithTwitterIDs:page:successBlock:errorBlock:

+ (QBRequest *)usersWithTwitterIDs:(NSArray *)twitterIDs page:(QBGeneralResponsePage *)page successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with twitter ids (with extended set of pagination parameters)

Parameters

twitterIDs: Twitter IDs of users which you want to retrieve

page: Pagination parameters

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

usersWithTwitterIDs:successBlock:errorBlock:

+ (QBRequest *)usersWithTwitterIDs:(NSArray *)twitterIDs successBlock:(void ( ^ ) ( QBResponse *response , QBGeneralResponsePage *page , NSArray *users ))successBlock errorBlock:(void ( ^ ) ( QBResponse *response ))errorBlock

Discussion

Retrieve users with twitter ids (max 10 users)

Parameters

twitterIDs: Twitter IDs of users which you want to retrieve

successBlock: Block with response, page and users instances if request succeded

errorBlock: Block with response instance if request failed

Return Value

An instance of QBRequest for cancel operation mainly.

Declared In

QBRequest+QBUsers.h

Instance Methods

addParameter:forKey:

- (void)addParameter:(id)obj forKey:(NSString *)key

addParametersFromDictionary:

- (void)addParametersFromDictionary:(NSDictionary *)otherDictionary

cancel

- (void)cancel

extractParametersFromDictionary:

- (void)extractParametersFromDictionary:(NSDictionary *)parameters

initWithCompletionBlock:

- (instancetype)initWithCompletionBlock:(QBRequestCompletionBlock)completionBlock

initWithUpdateBlock:completionBlock:

- (instancetype)initWithUpdateBlock:(QBRequestStatusUpdateBlock)updateBlock completionBlock:(QBRequestCompletionBlock)completionBlock

removeParameterForKey:

- (void)removeParameterForKey:(NSString *)key

QBRequest Class Reference

Tasks

Other Methods

QBChat Methods

QBContent Methods

QBAuth Methods

QBCustomObjects Methods

QBLocation Methods

QBPushNotifications Methods

QBUsers Methods

Properties

body

canceled

completionBlock

encoding

headers

operation

parameters

requestSerialisator

responseSerialisators

updateBlock

Class Methods

TDownloadFileWithBlobID:successBlock:statusBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

TUpdateFileWithData:file:successBlock:statusBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

TUploadFile:fileName:contentType:isPublic:successBlock:statusBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

blobObjectAccessWithBlobID:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

blobWithID:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

blobsForPage:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

blobsWithSuccessBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

completeBlobWithID:size:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

countObjectsWithClassName:extendedRequest:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

countOfDialogsWithExtendedRequest:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

countOfMessagesForDialogID:extendedRequest:successBlock:errorBlock:

Discussion

Parameters

Return Value

Declared In

createBlob:successBlock:errorBlock:

Discussion

Parameters