BlackBerry Spark Communications Services for iOS  1.9.0
BBMContainer Class Reference
Inheritance diagram for BBMContainer:
BBMLiveList BBMLiveMap

Instance Methods

(NSString *) - identifierOfElement:
 
(id) - objectForKeyedSubscript:
 
(void) - reset
 

Properties

BBMDSModelmasterModel
 The top level container. required to resolve foreign keys. More...
 
NSString * type
 The container type. More...
 
NSString * className
 The name of the class the container holds or vends. More...
 
Class classObject
 The class the container holds or vends. More...
 
void(^ allElementsReceivedCompletion )(NSArray *)
 

Detailed Description

BBMContainer is the base class for BBMDS containers. It provides shared functionality for:

  • model object factory
  • accessing the data model schema used to describe foreign keys
  • deriving the "identifier" string from an model object that can be used as foreign key
    Since
    R3

Method Documentation

◆ identifierOfElement:()

- (NSString *) identifierOfElement: (NSDictionary *)  anElement

Returns the identifier of the element based on the class object for this container.

Parameters
anElementThis is the element that will be used to get the identifier.
Returns
The identifier calculated using the class object of the container and the incoming element.
Since
R3

◆ objectForKeyedSubscript:()

- (id) objectForKeyedSubscript: (id)  key

Returns the value for the incoming key.

Parameters
keyThis is the key that will be used to access the container.
Returns
This is the object for the given key.
Since
R3

Implemented in BBMLiveMap.

◆ reset()

- (void) reset

Removes all the data in the container.

Since
R3

Property Documentation

◆ allElementsReceivedCompletion

- (void(^ allElementsReceivedCompletion) (NSArray *))
readwriteatomicstrong

a completion block that is called with the array of all BBMElements received or modified in the current/next processing of listAll or listElements

Since
R3

◆ className

- (NSString*) className
readatomicassign

The name of the class the container holds or vends.

Since
R3

◆ classObject

- (Class) classObject
readatomicassign

The class the container holds or vends.

Since
R3

◆ masterModel

- (BBMDSModel*) masterModel
readatomicweak

The top level container. required to resolve foreign keys.

Since
R3

◆ type

- (NSString*) type
readatomicassign

The container type.

Since
R3