Avaya Client Services API Reference (iOS)
Instance Methods | Properties | List of all members
CSIOSWhiteboardCanvas Class Reference

CSIOSWhiteboardCanvas object provides whiteboard canvas on which user can draw and received whiteboard drawings are displayed. More...

#import <CSIOSWhiteboardCanvas.h>

Inherits UIView.

Instance Methods

(instancetype) - initWithFrame:
 Initializes with frame. More...
 
(instancetype) - initWithCoder:
 Initializes with coder. More...
 
(void) - clearWhiteboardWithCompletionHandler:
 Clears whiteboard. More...
 

Properties

CSWhiteboardSurfacewhiteboardSurface
 Current whiteboard surface of whiteboard. More...
 
UIColor * color
 Current color of drawing on whiteboard. More...
 
CSWhiteboardTool tool
 Current tool for drawing on whiteboard. More...
 

Detailed Description

CSIOSWhiteboardCanvas object provides whiteboard canvas on which user can draw and received whiteboard drawings are displayed.

Method Documentation

- (void) clearWhiteboardWithCompletionHandler: (void(^)(CSWhiteboardSurface *surface, NSError *error))  handler

Clears whiteboard.

Operation is completed on whiteboard canvas (drawings are removed) after response from server. There's also corresponding method CSWhiteboardSurface::clearContentWithCompletionHandler: but, unless you want to create custom whiteboard canvas, use this one.

Parameters
handlerA block to be called when the operation is completed.
  • surface CSWhiteboardSurface object which was cleared.
  • error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
- (instancetype) initWithCoder: (NSCoder *)  coder

Initializes with coder.

Parameters
coderCoder that CSWhiteboardCanvas is initialized with.
- (instancetype) initWithFrame: (CGRect)  frameRect

Initializes with frame.

Parameters
frameRectRect that CSWhiteboardCanvas is initialized with.

Property Documentation

- (UIColor*) color
readwritenonatomicstrong

Current color of drawing on whiteboard.

Default color is set to black.

- (CSWhiteboardTool) tool
readwritenonatomicassign

Current tool for drawing on whiteboard.

Default tool is set to eMove.

- (CSWhiteboardSurface*) whiteboardSurface
readwritenonatomicstrong

Current whiteboard surface of whiteboard.


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