BlackBerry Spark Communications Services for iOS  1.9.0
BBMIdentitiesGetMessage Class Reference
Inheritance diagram for BBMIdentitiesGetMessage:
BBMJSONMessage

Instance Methods

(id) - init
 
- Instance Methods inherited from BBMJSONMessage
(NSString *) - requestData
 
(NSDictionary *) - requestDict
 

Properties

NSString * cookie
 
NSArray * appUserIds
 
NSArray * regIds
 

Detailed Description

Represents the identitiesGet protocol message.

Requests that the given list of identities, either application user ids or Spark Communications regIds, be resolved to find the associated identity information, and returned via an 'identities' message.

Identities for which identity information cannot be found are omitted from the results.

Overlapping 'identitiesGet' requests are issued in parallel. Issuing too many parallel requests at once can exceed system limits and cause those requests to fail.

Since
R6

Property Documentation

◆ appUserIds

- (NSArray*) appUserIds
readwritenonatomicstrong

A list of application user ids to lookup. Either this or 'regIds' must be specified.

Since
R6

◆ cookie

- (NSString*) cookie
readnonatomicstrong

An opaque value to be returned in the associated 'identities' response.

Since
R6

◆ regIds

- (NSArray*) regIds
readwritenonatomicstrong

A list of Spark Communications regIds to lookup. Either this or 'appUserIds' must be specified.A maximum of 50 identities can be present in one request. If more identities are present, 'identities' will return a 'Failure'.

Since
R6