CBEContainer

Introduction

collection of Item, can represent a table.

Methods

-createContainer:delegate:

-createObject:delegate:keyValues:

-getAcl:

-move:delegate:

-publish:privacy:description:password:delegate:

-query:

-query:delegate:

-remove:

-rename:delegate:

-setAcl:delegate:

-setAcl:delegate:

-share:description:delegate:

-unpublish:

-unShare:delegate:

-unsubscribe:

-upload:length:data:delegate:

createContainer:delegate:

-(CBEContainer*) createContainer: (NSString*) name delegate: (id<CreateContainerDelegatePtr>) delegate; 

Parameters

Discussion

Creates a container inside this container to be used for adding objects.

createObject:delegate:keyValues:

-(CBEObject*) createObject: (NSString*) name delegate: (id<CreateObjectDelegatePtr>) delegate 
        keyValues: (NSDictionary*) keyValues; 

Parameters

Discussion

Creates an object with indexed tags or indexed tags + non indexed tags.

getAcl:

-(void) getAcl:(id<GetAclDelegatePtr>) delegate; 

Parameters

Discussion

get the Access Control List \c ACL of the Container.

move:delegate:

-(void) move: (CBEContainerId) destinationId delegate: (id<MoveContainerDelegatePtr>) delegate; 

Parameters

Discussion

Move is used to move container with its content to user specified location e.g. other container or to root container.

publish:privacy:description:password:delegate:

-(void) publish: (CBEPublishAccess) security privacy: (CBEPublishVisibility) privacy 
        description: (NSString*) description password: (NSString*) password 
        delegate: (id<PublishDelegatePtr>) delegate; 

Parameters

Discussion

Publishes a container and its content to a user.

query:

-(CBEQueryChain*) query: (id<QueryDelegatePtr>) queryDelegate; 

Discussion

In line with function CloudBackend::query(ContainerId,QueryDelegatePtr), but with its \p ContainerId parameter excluded. \see CloudBackend::query(ContainerId,QueryDelegatePtr)

query:delegate:

-(CBEQueryChain*) query: (CBEFilter*) filter delegate: (id<QueryDelegatePtr>) queryDelegate; 

Discussion

In line with function CloudBackend::query(ContainerId,Filter,QueryDelegatePtr), but with its \p ContainerId parameter excluded. \see CloudBackend::query(ContainerId,Filter,QueryDelegatePtr)

remove:

-(void) remove: (id<RemoveContainerDelegatePtr>) delegate; 

Parameters

Discussion

Removes/deletes the container and all its content.

rename:delegate:

-(void) rename: (NSString*) name delegate: (id<RenameContainerDelegatePtr>) delegate; 

Parameters

Discussion

Rename the container.

setAcl:delegate:

- (void) setAcl: (NSDictionary*) aclMap delegate: (id<SetAclDelegatePtr>) delegate; 

Parameters

Discussion

Queries the container with a given relative path, returns container with objects. \n E.g. /Documents/Pictures will return objects and subContainers for Pictures. \n N.B.: .. or . path options are not available, top down Paths in the container tree are available.

setAcl:delegate:

- (void) setAcl: (NSDictionary*) aclMap delegate: (id<SetAclDelegatePtr>) delegate; 

Parameters

Discussion

Set the Access Control List \c ACL for the container. For containers set does set the whole container tree, so all its sub items as well. Remember this is set and not update so every time you set all ids that should be there should be added.

share:description:delegate:

-(void) share: (CBEUserId) toUserGroup description: (NSString*) description 
        delegate: (id<ShareDelegatePtr>) delegate; 

Parameters

Discussion

Shares a container and its content to a user. This provides the user the ability to access what has been shared to them via the listAvailableShares command. To allow users to view and change shared information see \c ACL . \note At present Sharing the container gives the user read permissions for the container and all its sub-items, this might change in the future.

unpublish:

-(void) unpublish:(id<UnpublishDelegatePtr>) delegate; 

Parameters

Discussion

Unpublishes this container.

unShare:delegate:

-(void) unShare: (CBEShareId) shareId delegate: (id<UnShareDelegatePtr>) delegate; 

Parameters

Discussion

unShare the container to a specific shareId created when sharing. Each share is unique between user/group and the one sharing. This is represented with a unique share id.

unsubscribe:

-(void) unsubscribe:(id<UnsubscribeDelegatePtr>) delegate; 

Parameters

Discussion

Unsubscribes from this container.

upload:length:data:delegate:

-(CBEObject*) upload: (NSString*) name length: (uint64_t) length 
        data: (NSData*) data delegate: (id<UploadDelegatePtr>) delegate; 

Parameters