TWSDocumentDelegate Protocol Reference

Conforms to NSObject
Declared in TWSDocument.h

Overview

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

– onDocumentResultOpened:

Called when the document referenced is opened.

- (void)onDocumentResultOpened:(nonnull TWSDocument *)document

Parameters

document

The document.

Discussion

Called when the document referenced is opened.

Declared In

TWSDocument.h

– onDocument:resultRemovedForFlowID:

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

- (void)onDocument:(nonnull TWSDocument *)document resultRemovedForFlowID:(NSUInteger)flowId

Parameters

document

The document.

flowId

A developer specified identifier for this remote request.

Discussion

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

Declared In

TWSDocument.h

– onDocument:resultDataUpdated:forFlowID:

Called when the document is modified as a result of a local operation.

- (void)onDocument:(nonnull TWSDocument *)document resultDataUpdated:(nonnull TWSData *)data forFlowID:(NSUInteger)flowId

Parameters

document

The document.

data

The updated data for the document.

flowId

A developer specified identifier for this remote request.

Discussion

Called when the document is modified as a result of a local operation.

Declared In

TWSDocument.h

– onDocument:resultErrorOccurred:forFlowID:

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

- (void)onDocument:(nullable TWSDocument *)document resultErrorOccurred:(nonnull TWSError *)error forFlowID:(NSUInteger)flowId

Parameters

document

The document.

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

TWSDocument.h

– onDocument:remoteUpdated:

Called when the document is modified as a result of a remote operation.

- (void)onDocument:(nonnull TWSDocument *)document remoteUpdated:(nonnull TWSData *)data

Parameters

document

The document.

data

The updated data for the document.

Discussion

Called when the document is modified as a result of a remote operation.

Declared In

TWSDocument.h

– onDocumentRemoteRemoved:

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

- (void)onDocumentRemoteRemoved:(nonnull TWSDocument *)document

Parameters

document

The document.

Discussion

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

Declared In

TWSDocument.h

– onDocument:remoteErrorOccurred:

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

- (void)onDocument:(nonnull TWSDocument *)document remoteErrorOccurred:(nonnull TWSError *)error

Parameters

document

The document.

error

The error encounted.

Discussion

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

Declared In

TWSDocument.h