# Namespace: Collaboration

AvayaClientServices.Services.Collaboration contains all classes that belong to Collaboration module. For Collaboration module class, see AvayaClientServices.Services.Collaboration.Collaboration.

## Classes

AbstractShape
Bitmap
Circle
CircleTool
ClearTool
Collaboration
CollaborationError
Collaborations
ContentSharing
DeleteTool
Frame
LineTool
MarkerTool
Participant
PenTool
Point
RectangleTool
SelectionTool
Shape
Slider
SliderSlide
StampTool
TextTool
Whiteboard
WhiteboardRenderer
WhiteboardSurface
WhiteboardText
WhiteboardTools

## Members

#### <static, readonly> CollaborationErrorReason :String

  Dictionary containing collaboration related error codes.

  ##### Type:

  - String

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `COLLABORATION_START_FAILURE` | String | Failed to start collaboration. | Error reason.
  `COLLABORATION_STOP_FAILURE` | String | Failed to stop collaboration. | Error reason.
  `COLLABORATION_NOTIFICATIONS_CHANNEL_FAILED` | String | Start notification channel failed. | Error reason.
  `BROWSER_NOT_SUPPORTED` | String | Browser is not supported | Error reason.
  `WHITEBOARD_REMOVE_LAST_SURFACE` | String | Failed to remove surface. You cannot remove last surface. | Error reason.
  `WHITEBOARD_REMOVE_SURFACE_FAILED` | String | Failed to remove surface. | Error reason.
  `WHITEBOARD_REMOVE_SHAPE_NOT_MINE` | String | Failed to remove shape. You can only remove shapes that you drew. | Error reason.
  `WHITEBOARD_ALREADY_ACTIVE` | String | Failed to start whiteboard surface. Surface is already started. | Error reason.
  `WHITEBOARD_INACTIVE` | String | Whiteboard is not started. | Error reason.
  `WHITEBOARD_UNAVAILABLE` | String | Whiteboard unavailable. | Error reason.
  `SHARING_INACTIVE` | String | Sharing is not started | Error reason.
  `INTERNAL_ERROR` | String | An internal error occurred. | Error reason.

#### <static> ContentSharingButtonEventType :string

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `NONE` | string | 0 |
  `PRESSED` | string | 1 |
  `RELEASED` | string | 2 |
  `CLICKED` | string | 3 |
  `DOUBLE_CLICKED` | string | 4 |

#### <static> ContentSharingButtonPressedType :string

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `NONE` | string | 0 |
  `LEFT` | string | 1 |
  `RIGHT` | string | 2 |
  `MIDDLE` | string | 3 |

#### <static> ContentSharingKeyboardEventType :string

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `NONE` | string | 0 |
  `PRESSED` | string | 1 |
  `RELEASED` | string | 2 |

#### <static> ContentSharingType :string

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `NONE` | string | none |
  `FULL_SCREEN_SHARING` | string | full screen |
  `APP_WINDOW_SHARING` | string | application window |
  `ANY_TYPE` | string | any type |
  `VIDEO_ANY_TYPE` | string | video any type |

#### <static, readonly> FeaturesAvailable :string

  Features available in WCS

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `LIBRARY` | string | LIBRARY |
  `POLLING` | string | POLLING |
  `MINUTES` | string | MINUTES |
  `WHITEBOARD` | string | WHITEBOARD |
  `MESSAGES` | string | MESSAGES |
  `REPORTS` | string | REPORTS |
  `SCREEN_SHARING` | string | SCREEN_SHARING |
  `SLIDER` | string | SLIDER |
  `REMOTE_CONTROL` | string | REMOTE_CONTROL |
  `VIDEO_SHARING_CONTROL_MESSAGING` | string | VIDEO_SHARING_CONTROL_MESSAGING |

#### <static, readonly> PrimitiveShapeSizes :Number

  Primitive shape size for each shape in whiteboard.

  ##### Type:

  - Number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `TEXT` | Number | 1 | Primitive Shape size of Text.
  `CIRCLE` | Number | 1 | Primitive Shape size of Circle.
  `LINE` | Number | 1 | Primitive Shape size of Line.
  `STAMP` | Number | 5 | Primitive Shape size of Stamp.
  `RECTANGLE` | Number | 4 | Primitive Shape size of Rectangle.

#### <static> RemoteControlRole :string

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `PARTICIPANT` | string | PARTICIPANT |
  `CONTROLLER` | string | CONTROLLER |
  `CONTROLLEE` | string | CONTROLLEE |

#### <static> RendererError :string

  An enumeration of renderer errors

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `MAX_SHAPES_LIMIT_REACHED` | string | MAX_SHAPES_LIMIT_REACHED |

#### <static, readonly> SelectionStatus :string

  Possible states for a selected shape or a new shape.

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `PENDING` | string | PENDING | Response not yet received.
  `CONFIRMED` | string | CONFIRMED | Shape has been successfully sent to the server and response has been received.
  `ERROR` | string | ERROR | Server returned an error.

#### <static, readonly> WhiteboardLineWidths :Number

  Widths of the line tool for whiteboard.

  ##### Type:

  - Number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `SMALL` | Number | 4 | Thickness of the line in pixels.
  `MEDIUM` | Number | 8 | Thickness of the line in pixels.
  `LARGE` | Number | 12 | Thickness of the line in pixels.

#### <static, readonly> WhiteboardPenMarkerWidths :Number

  Width of the pen and marker tool for whiteboard.

  ##### Type:

  - Number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `CUSTOM_STROKE` | Number | CUSTOM_STROKE | Custom stroke width of the pen and marker.

#### <static, readonly> WhiteboardTextSizes :Number

  Font sizes of text tool for whiteboard.

  ##### Type:

  - Number

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `SMALL` | Number | 19 | Text height in pixels.
  `MEDIUM` | Number | 23 | Text height in pixels.
  `LARGE` | Number | 27 | Text height in pixels.

#### <static, readonly> WhiteboardToolModes :string

  Modes of tools (rectangle, circle) for a whiteboard.

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `STROKE` | string | STROKE | Shape stroke mode. Shape is not filled - has just outline.
  `FILLED` | string | FILLED | Shape filled mode. Shape is filled with a color.
  `CUSTOM_STROKE` | string | CUSTOM_STROKE | Shape custom stroke mode. Shape is not filled - has just outline.

#### <static, readonly> WhiteboardToolTypes :string

  All types of tools supported by the whiteboard.

  ##### Type:

  - string

  ##### Properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `SELECTION` | string | SELECTION | Selection tool moves a shape on the whiteboard.
  `RECTANGLE` | string | RECTANGLE | Rectangle tool draws a rectangle on the whiteboard.
  `CIRCLE` | string | CIRCLE | Circle tool draws a circle on the whiteboard.
  `MARKER` | string | MARKER | Marker tool draws a thick line with a given color while the user moves the cursor over the whiteboard.
  `PEN` | string | PEN | Pen tool draws a thin line with a given color while the user moves the cursor over the whiteboard.
  `LINE` | string | LINE | Line tool draws a line on the whiteboard.
  `STAMP` | string | STAMP | Stamp tool puts a stamp on the whiteboard.
  `TEXT` | string | TEXT | Text tool writes a text on the whiteboard.
  `DELETE` | string | DELETE | Delete shape tool deletes just a single shape.
  `CLEAR` | string | CLEAR | Clear whiteboard tool clears the whole whiteboard.

## Methods

#### <static> RendererException(name, message)

  Exception representing an error related to the renderer.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `name` | AvayaClientServices.Services.Collaboration.RendererError |
  `message` | string |