Avaya Client Services API Reference (iOS)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSWhiteboardSurfaceDelegate> Protocol Reference

CSWhiteboardSurfaceDelegate is registered as an observer of whiteboard surface update notifications. More...

`#import <CSWhiteboardSurface.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - whiteboardSurfaceDidClearSurface:
| Reports that a whiteboard surface content was cleared by one of collaboration participant excluding local user. More...
(void) | - whiteboardSurface:didAddShape:
| Reports that a shape was added by one of the collaboration participant excluding local user. More...
(void) | - whiteboardSurface:didUpdateShape:
| Reports that a shape was updated by one of the collaboration participant excluding local user. More...
(void) | - whiteboardSurface:didEndShape:
| Reports that on whiteboard page user has finished drawing shape. More...
(void) | - whiteboardSurface:didDeleteShape:
| Reports that a shape was deleted by one of the collaboration participant excluding local user. More...

## Detailed Description

CSWhiteboardSurfaceDelegate is registered as an observer of whiteboard surface update notifications.

Client doesn't need to implement this protocol unless custom whiteboard canvas is developed. This delegate is used internally by Client SDK.

See also
  CSWhiteboardSurface

## Method Documentation

- (void) whiteboardSurface: |  | (CSWhiteboardSurface *) | surface
didAddShape: |  | (CSBasicShape *) | shape
| optional

Reports that a shape was added by one of the collaboration participant excluding local user.

In case of local user this event reported is by completion handler in addShapeWithPoints:color:width:isFilled:isFinished:completionHandler: (CSWhiteboardSurface).

Parameters

  surface | The whiteboard surface sending the message.
  shape | Added shape.

See also
  - addShapeWithPoints:color:width:isFilled:isFinished:completionHandler: (CSWhiteboardSurface)

- (void) whiteboardSurface: |  | (CSWhiteboardSurface *) | surface
didDeleteShape: |  | (CSBasicShape *) | shape
| optional

Reports that a shape was deleted by one of the collaboration participant excluding local user.

In case of local user this event reported is by completion handler in deleteShape:completionHandler: (CSWhiteboardSurface).

Parameters

  surface | The whiteboard surface sending the message.
  shape | Deleted shape.

See also
  - deleteShape:completionHandler: (CSWhiteboardSurface)

- (void) whiteboardSurface: |  | (CSWhiteboardSurface *) | surface
didEndShape: |  | (CSBasicShape *) | shape
| optional

Reports that on whiteboard page user has finished drawing shape.

Parameters

  surface | The whiteboard surface sending the message.
  shape | Finished shape.

- (void) whiteboardSurface: |  | (CSWhiteboardSurface *) | surface
didUpdateShape: |  | (CSBasicShape *) | shape
| optional

Reports that a shape was updated by one of the collaboration participant excluding local user.

In case of local user this event reported is by completion handler in updateShape:completionHandler: (CSWhiteboardSurface).

Parameters

  surface | The whiteboard surface sending the message.
  shape | Updated shape.

See also
  - updateShape:completionHandler: (CSWhiteboardSurface)

- (void) whiteboardSurfaceDidClearSurface: |  | (CSWhiteboardSurface *) | surface |

Reports that a whiteboard surface content was cleared by one of collaboration participant excluding local user.

In case of local user this event reported is by completion handler in clearContentWithCompletionHandler: (CSWhiteboardSurface).

Parameters

  surface | The whiteboard surface sending the message.

See also
  - clearContentWithCompletionHandler: (CSWhiteboardSurface)

The documentation for this protocol was generated from the following file:

- CSWhiteboardSurface.h