CBEGroupQueryResult

Superclass:
NSObject
Declared In:

Introduction

Resultset of data retrieved in a search for Group.



Methods

-containsGroup:
-filter
-getGroupsSnapshot
-GroupsLoaded
-totalCount

containsGroup:


-(bool) containsGroup:(uint64_t) groupId; 
Parameters
groupId

the group id number in question

Discussion

asking if the group with groupId was loaded in the query.


filter


-(CBEGroupFilter*) filter; 
Discussion

Returns a copy of the filter used for query.


getGroupsSnapshot


-(NSArray*) getGroupsSnapshot; 
Return Value

vector<cbe::Group> containing the groups matching the query.

Discussion

Returns a copy of a vector containing the groups for the queryResult. The queryResult will update when new data comes in but the copy will not. If iterating, make sure to create a variable for a local copy.


GroupsLoaded


-(uint64_t) GroupsLoaded; 
Discussion

Number of groups loaded in the queryResult.


totalCount


-(uint64_t) totalCount; 
Discussion

Total number of Groups in the cloud matching the query result. This may be more than loaded.