TWSMapDelegate Protocol Reference

Conforms to NSObject
Declared in TWSMap.h

Overview

The delegate that will be called with lifecycle updates for the map.

– onMapResultOpened:

Called when the map referenced is opened.

- (void)onMapResultOpened:(nonnull TWSMap *)map

Parameters

map

The map.

Discussion

Called when the map referenced is opened.

Declared In

TWSMap.h

– onMap:resultItemSetWithKey:forFlowID:

Called when a map item is set as a result of a local operation.

- (void)onMap:(nonnull TWSMap *)map resultItemSetWithKey:(nonnull NSString *)itemKey forFlowID:(NSUInteger)flowId

Parameters

map

The map.

itemKey

The key of the item.

flowId

A developer specified identifier for this remote request.

Discussion

Called when a map item is set as a result of a local operation.

Declared In

TWSMap.h

– onMap:resultItemRemovedWithKey:forFlowID:

Called when the map item at the specified index is removed as a result of a local operation.

- (void)onMap:(nonnull TWSMap *)map resultItemRemovedWithKey:(nonnull NSString *)itemKey forFlowID:(NSUInteger)flowId

Parameters

map

The map.

itemKey

The key of the item.

flowId

A developer specified identifier for this remote request.

Discussion

Called when the map item at the specified index is removed as a result of a local operation.

Declared In

TWSMap.h

– onMap:resultErrorOccurred:forFlowID:

Called when an error occurs as a result of a local operation.

- (void)onMap:(nullable TWSMap *)map resultErrorOccurred:(nonnull TWSError *)error forFlowID:(NSUInteger)flowId

Parameters

map

The map.

error

The error encounted.

flowId

A developer specified identifier for this remote request.

Discussion

Called when an error occurs as a result of a local operation.

Declared In

TWSMap.h

– onMap:resultCollectionRemovedForFlowID:

Called when the map is removed as a result of a local operation.

- (void)onMap:(nonnull TWSMap *)map resultCollectionRemovedForFlowID:(NSUInteger)flowId

Parameters

map

The map.

flowId

A developer specified identifier for this remote request.

Discussion

Called when the map is removed as a result of a local operation.

Declared In

TWSMap.h

– onMap:remoteItemAddedWithKey:item:

Called when a map item is added as a result of a remote operation.

- (void)onMap:(nonnull TWSMap *)map remoteItemAddedWithKey:(nonnull NSString *)itemKey item:(nonnull TWSMapItem *)item

Parameters

map

The map.

itemKey

The key of the item.

item

The item.

Discussion

Called when a map item is added as a result of a remote operation.

Declared In

TWSMap.h

– onMap:remoteItemUpdatedWithKey:item:

Called when a map item is updated as a result of a remote operation.

- (void)onMap:(nonnull TWSMap *)map remoteItemUpdatedWithKey:(nonnull NSString *)itemKey item:(nonnull TWSMapItem *)item

Parameters

map

The map.

itemKey

The key of the item.

item

The item.

Discussion

Called when a map item is updated as a result of a remote operation.

Declared In

TWSMap.h

– onMap:remoteItemRemovedWithKey:

Called when a map item is removed as a result of a remote operation.

- (void)onMap:(nonnull TWSMap *)map remoteItemRemovedWithKey:(nonnull NSString *)itemKey

Parameters

map

The map.

itemKey

The key of the item.

Discussion

Called when a map item is removed as a result of a remote operation.

Declared In

TWSMap.h

– onMapRemoteCollectionRemoved:

Called when the map is removed as a result of a remote operation.

- (void)onMapRemoteCollectionRemoved:(nonnull TWSMap *)map

Parameters

map

The map.

Discussion

Called when the map is removed as a result of a remote operation.

Declared In

TWSMap.h

– onMap:remoteErrorOccurred:

Called when an error occurs as a result of a remote operation.

- (void)onMap:(nonnull TWSMap *)map remoteErrorOccurred:(nullable TWSError *)error

Parameters

map

The map.

error

The error encounted.

Discussion

Called when an error occurs as a result of a remote operation.

Declared In

TWSMap.h