CBEObject

Introduction

holder of a set of data, can represent a table row.

Methods

-getAcl:

-getMimeType

-getObjectType

-getStreams:

-keyValues

-length

-move:delegate:

-publish:privacy:description:password:delegate:

-remove:

-rename:delegate:

-setAcl:delegate:

-share:description:delegate:

-streams

Returns the currently loaded stream / streams attached to the object. If you upload a new stream with @c uploadStream(), you must call getStreams() again to get the new/updated streams. \note If @c getStreams() has not been called, then @c streams() returns an empty Streams object.

-unpublish:

-unShare:delegate:

-unsubscribe:

-updateKeyValues:keyValues:

getAcl:

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

Parameters

Discussion

get the Access Control List for the Object.

getMimeType

- (NSString*) getMimeType; 

Discussion

Returns the mime type of the object. \n E.g. application/pdf, audio/wav, image/jpg, text/xml, video/mp4 etc.

getObjectType

- (CBEObjectType) getObjectType; 

Discussion

Returns the Object type currently: Other | GroupInvite | ShareInvite

getStreams:

-(void) getStreams: (id<GetStreamsDelegatePtr>) delegate; 

Parameters

Discussion

*

keyValues

- (NSDictionary*) keyValues; 

Discussion

Returns all the key/values in a map.

length

- (uint64_t) length; 

Discussion

Returns the binary length/size of the object in Bytes.

move:delegate:

-(void) move:(CBEObjectId) destinationContainerId delegate:(id<MoveObjectDelegatePtr>) delegate; 

Parameters

Discussion

to relocate an object to a different 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 an object to a user.

remove:

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

Parameters

Discussion

Remove the object from cloud and locally

rename:delegate:

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

Parameters

Discussion

Rename object:

setAcl:delegate:

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

Parameters

Discussion

Set the Access control list for the object.

share:description:delegate:

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

Parameters

Discussion

Share Object to a user. Notifies the user that a share has occured so that the user can check what permissions the have been given. Sharing gives read permissions as of right now but might change in the future.

streams

Returns the currently loaded stream / streams attached to the object. If you upload a new stream with @c uploadStream(), you must call getStreams() again to get the new/updated streams. \note If @c getStreams() has not been called, then @c streams() returns an empty Streams object.

- (NSArray*) streams; 

unpublish:

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

Parameters

Discussion

Unpublishes this object.

unShare:delegate:

-(void) unShare: (CBEUserId) toUserGroup delegate: (id<UnShareDelegatePtr>) delegate; 

Parameters

Discussion

unShare the object 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 object.

updateKeyValues:keyValues:

-(void) updateKeyValues: (id<UpdateKeyValuesObjectDelegatePtr>) delegate 
        keyValues: (NSDictionary*) keyValues; 

Parameters

Discussion

Adds key/value pair data to the object. \note Existing key will be overwritten, otherwise created.