Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

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

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

Whiteboard delegate provides updates about the status of whiteboard sharing. More...

`#import <CSWhiteboard.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - whiteboardDidEnd:
| Sent when the whiteboard session ends, either by a local or remote action. More...
(void) | - whiteboard:didStartWithSurface:byParticipant:
| Sent when the whiteboard session starts, either by a local or remote action. More...
(void) | - whiteboard:didSetActiveSurface:byParticipant:
| Sent when the whiteboard active surface changes, either by a local or remote action. More...
(void) | - whiteboard:didAddSurface:byParticipant:
| Sent when the whiteboard surface is added, either by a local or remote action. More...
(void) | - whiteboard:didRemoveSurface:byParticipant:
| Sent when the whiteboard surface is removed, either by a local or remote action. More...

## Detailed Description

Whiteboard delegate provides updates about the status of whiteboard sharing.

Shapes drawn during a content sharing session is reported through the vector returned from getShapes method. As a result, no separate shape added/removed/updated callbacks are provided through the delegate.

## Method Documentation

- (void) whiteboard: |  | (CSWhiteboard *) | whiteboard
didAddSurface: |  | (CSWhiteboardSurface *) | surface
byParticipant: |  | (CSParticipant *) | participant

Sent when the whiteboard surface is added, either by a local or remote action.

Parameters

  whiteboard | CSWhiteboard object sending the message.
  surface | Added whiteboard surface
  participant | Data of participant who added surface.

See also
  - requestNewSurfaceWithCompletionHandler: (CSWhiteboard)

- (void) whiteboard: |  | (CSWhiteboard *) | whiteboard
didRemoveSurface: |  | (CSWhiteboardSurface *) | surface
byParticipant: |  | (CSParticipant *) | participant

Sent when the whiteboard surface is removed, either by a local or remote action.

Parameters

  whiteboard | CSWhiteboard object sending the message.
  surface | Removed whiteboard surface
  participant | Data of participant who removed surface.

See also
  - removeSurface:withCompletionHandler: (CSWhiteboard)}

- (void) whiteboard: |  | (CSWhiteboard *) | whiteboard
didSetActiveSurface: |  | (CSWhiteboardSurface *) | surface
byParticipant: |  | (CSParticipant *) | participant

Sent when the whiteboard active surface changes, either by a local or remote action.

Parameters

  whiteboard | CSWhiteboard object sending the message.
  surface | Whiteboard surface set as active.
  participant | Data of participant who set whiteboard surface active.

See also
  - setAsActiveWithCompletionHandler: (CSWhiteboardSurface)

- (void) whiteboard: |  | (CSWhiteboard *) | whiteboard
didStartWithSurface: |  | (CSWhiteboardSurface *) | surface
byParticipant: |  | (CSParticipant *) | participant

Sent when the whiteboard session starts, either by a local or remote action.

Parameters

  whiteboard | CSWhiteboard object sending the message.
  surface | Active surface of started whiteboard session.
  participant | Data of participant who started whiteboard.

See also
  - startWithCompletionHandler: (CSWhiteboard)

- (void) whiteboardDidEnd: |  | (CSWhiteboard *) | whiteboard |

Sent when the whiteboard session ends, either by a local or remote action.

Parameters

  whiteboard | CSWhiteboard object sending the message.

See also
  - endWithCompletionHandler: (CSWhiteboard)

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

- CSWhiteboard.h