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_FAILUREString Failed to start collaboration. Error reason.
COLLABORATION_STOP_FAILUREString Failed to stop collaboration. Error reason.
COLLABORATION_NOTIFICATIONS_CHANNEL_FAILEDString Start notification channel failed. Error reason.
BROWSER_NOT_SUPPORTEDString Browser is not supported Error reason.
WHITEBOARD_REMOVE_LAST_SURFACEString Failed to remove surface. You cannot remove last surface. Error reason.
WHITEBOARD_REMOVE_SURFACE_FAILEDString Failed to remove surface. Error reason.
WHITEBOARD_REMOVE_SHAPE_NOT_MINEString Failed to remove shape. You can only remove shapes that you drew. Error reason.
WHITEBOARD_ALREADY_ACTIVEString Failed to start whiteboard surface. Surface is already started. Error reason.
WHITEBOARD_INACTIVEString Whiteboard is not started. Error reason.
WHITEBOARD_UNAVAILABLEString Whiteboard unavailable. Error reason.
SHARING_INACTIVEString Sharing is not started Error reason.
INTERNAL_ERRORString An internal error occurred. Error reason.
-
<static> ContentSharingButtonEventType :string
-
Type:
- string
Properties:
Name Type Default Description NONEstring 0 PRESSEDstring 1 RELEASEDstring 2 CLICKEDstring 3 DOUBLE_CLICKEDstring 4
-
<static> ContentSharingButtonPressedType :string
-
Type:
- string
Properties:
Name Type Default Description NONEstring 0 LEFTstring 1 RIGHTstring 2 MIDDLEstring 3
-
<static> ContentSharingKeyboardEventType :string
-
Type:
- string
Properties:
Name Type Default Description NONEstring 0 PRESSEDstring 1 RELEASEDstring 2
-
<static> ContentSharingType :string
-
Type:
- string
Properties:
Name Type Default Description NONEstring none FULL_SCREEN_SHARINGstring full screen APP_WINDOW_SHARINGstring application window ANY_TYPEstring any type VIDEO_ANY_TYPEstring video any type
-
<static, readonly> FeaturesAvailable :string
-
Features available in WCS
Type:
- string
Properties:
Name Type Default Description LIBRARYstring LIBRARY POLLINGstring POLLING MINUTESstring MINUTES WHITEBOARDstring WHITEBOARD MESSAGESstring MESSAGES REPORTSstring REPORTS SCREEN_SHARINGstring SCREEN_SHARING SLIDERstring SLIDER REMOTE_CONTROLstring REMOTE_CONTROL VIDEO_SHARING_CONTROL_MESSAGINGstring VIDEO_SHARING_CONTROL_MESSAGING
-
<static, readonly> PrimitiveShapeSizes :Number
-
Primitive shape size for each shape in whiteboard.
Type:
- Number
Properties:
Name Type Default Description TEXTNumber 1 Primitive Shape size of Text.
CIRCLENumber 1 Primitive Shape size of Circle.
LINENumber 1 Primitive Shape size of Line.
STAMPNumber 5 Primitive Shape size of Stamp.
RECTANGLENumber 4 Primitive Shape size of Rectangle.
-
<static> RemoteControlRole :string
-
Type:
- string
Properties:
Name Type Default Description PARTICIPANTstring PARTICIPANT CONTROLLERstring CONTROLLER CONTROLLEEstring CONTROLLEE
-
<static> RendererError :string
-
An enumeration of renderer errors
Type:
- string
Properties:
Name Type Default Description MAX_SHAPES_LIMIT_REACHEDstring 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 PENDINGstring PENDING Response not yet received.
CONFIRMEDstring CONFIRMED Shape has been successfully sent to the server and response has been received.
ERRORstring ERROR Server returned an error.
-
<static, readonly> WhiteboardLineWidths :Number
-
Widths of the line tool for whiteboard.
Type:
- Number
Properties:
Name Type Default Description SMALLNumber 4 Thickness of the line in pixels.
MEDIUMNumber 8 Thickness of the line in pixels.
LARGENumber 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_STROKENumber 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 SMALLNumber 19 Text height in pixels.
MEDIUMNumber 23 Text height in pixels.
LARGENumber 27 Text height in pixels.
-
<static, readonly> WhiteboardToolModes :string
-
Modes of tools (rectangle, circle) for a whiteboard.
Type:
- string
Properties:
Name Type Default Description STROKEstring STROKE Shape stroke mode. Shape is not filled - has just outline.
FILLEDstring FILLED Shape filled mode. Shape is filled with a color.
CUSTOM_STROKEstring 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 SELECTIONstring SELECTION Selection tool moves a shape on the whiteboard.
RECTANGLEstring RECTANGLE Rectangle tool draws a rectangle on the whiteboard.
CIRCLEstring CIRCLE Circle tool draws a circle on the whiteboard.
MARKERstring MARKER Marker tool draws a thick line with a given color while the user moves the cursor over the whiteboard.
PENstring PEN Pen tool draws a thin line with a given color while the user moves the cursor over the whiteboard.
LINEstring LINE Line tool draws a line on the whiteboard.
STAMPstring STAMP Stamp tool puts a stamp on the whiteboard.
TEXTstring TEXT Text tool writes a text on the whiteboard.
DELETEstring DELETE Delete shape tool deletes just a single shape.
CLEARstring 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 nameAvayaClientServices.Services.Collaboration.RendererError messagestring