BlackBerry Spark Communications Services for iOS  1.11.0
BBMUser Class Reference
Inheritance diagram for BBMUser:
BBMElement BBMElementBase

Class Methods

(BBMUserKeyState+ valueForKeyStateString:
 
(NSString *) + stringForKeyStateValue:
 
- Class Methods inherited from BBMElementBase
(NSString *) + identifierOfElement:
 

Properties

BBMUserKeyState keyState
 
NSString * pin
 
NSNumber * regId
 
NSString * uri
 
- Properties inherited from BBMElement
BBMElementState bbmState
 
NSString * primaryKey
 
- Properties inherited from BBMElementBase
BBMContainerparentContainer
 The container (BBMLiveList or BBMLiveMap) holding this element. More...
 

Additional Inherited Members

- Instance Methods inherited from BBMElementBase
(BBMDSModel *) - masterModel
 
(id) - objectForKeyedSubscript:
 

Detailed Description

This list consists of all the users known to bbmcore. Other lists, such as the 'participant' list, often refer to entries in this 'user' list. Your application never requests the list in full. Instead, it uses 'requestListElements' calls to lookup one or more users by their 'uri'.

Since
R0

Property Documentation

◆ keyState

- (BBMUserKeyState) keyState
readnonatomicassign

The current state of the user's keys. A new protected user is created in the 'Import' state.

Since
R3

◆ pin

- (NSString*) pin
readnonatomicstrong

Holds the user's PIN as an 8-character lowercase hexadecimal string. This field will be omitted when the user has no PIN.

Since
R4

◆ regId

- (NSNumber*) regId
readnonatomicstrong

Holds the unique identifier for the user. This identifier is exposed to partner applications. If this field is not present, it indicates that the user does not have a regId or that the regId is unknown.

Since
R0

◆ uri

- (NSString*) uri
readnonatomicstrong

Holds the unique identifier for the user. See the URIs section for information on the URI format.

Since
R0