BISCapsule Class Reference

Inherits from NSObject
Declared in BISCapsule.h
BISCapsule.m

Overview

BISCapsule provides a simple interface for augmenting places in the real world with custom information. A capsule can be set to one or many regions through the regionDescription property

  capsuleId

Unique identifier string for this capsule. If this is nil, this capsule does not exist on the server.

@property (nonatomic, strong, readonly, nullable) NSString *capsuleId

Declared In

BISCapsule.h

  creationDate

UTC date that this capsule was created on the server. If this is nil, this capsule does not exist on the server.

@property (nonatomic, strong, readonly, nullable) NSDate *creationDate

Declared In

BISCapsule.h

  data

The data to be stored in this capsule. This must be set before calling updateWithCompletion:

@property (nonatomic, strong) NSString *data

Declared In

BISCapsule.h

  dataType

The type of data contained in this capsule specified by the BISCapsuleDataType Enum. When this is equal to BISCapsuleDataTypeUnknown, updateWithCompletion will return an error

@property (nonatomic, readonly) BISCapsuleDataType dataType

Declared In

BISCapsule.h

  regionDescription

The description of the region(s) this capsule is set to. This must be set before calling updateWithCompletion:

@property (nonatomic, strong) BISRegionDescription *regionDescription

Declared In

BISCapsule.h

  updatedDate

UTC date of the most recent update to this capsule on the server. If this is nil, this capsule does not exist on the server.

@property (nonatomic, strong, readonly) NSDate *updatedDate

Declared In

BISCapsule.h

– initWithData:regionDescription:

The data to be stored in this capsule

- (instancetype)initWithData:(NSString *)data regionDescription:(BISRegionDescription *)regionDescription

Parameters

data

The data to be stored in this capsule

regionDescription

The description of the region(s) this capsule is set to

Declared In

BISCapsule.h

– deleteWithCompletion:

Delete this BISCapsule object permanently

- (void)deleteWithCompletion:(void ( ^ ) ( BOOL success , NSError *__nullable error ))completion

Parameters

completion

Block that returns a BOOL indicating success or failure. If failure, error will describe what went wrong

Declared In

BISCapsule.h

– updateWithCompletion:

Add a new capsule to the server, or update an existing capsule if any properties have changed since the updatedDate

- (void)updateWithCompletion:(void ( ^ ) ( BOOL success , NSError *__nullable error ))completion

Parameters

completion

Block that returns a BOOL indicating success or failure. If failure, error will describe what went wrong

Declared In

BISCapsule.h