Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

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

Properties | List of all members
CSBasicShape Class Reference

Base class for shapes that can be drawn on whiteboard surface. More...

`#import <CSBasicShape.h>`

Inherits NSObject.

Inherited by CSCircleShape, CSShape, and CSWhiteboardText.

## Properties
NSString * | shapeId
| The shape ID associated with the particular shape object. More...
NSUInteger | color
| Color of shape in ARGB format. More...
CGFloat | width
| Width of shape. More...
CGPoint | translation
| Geometric translation of shape. More...
CSShapeSelectionStatus | selectionStatus
| Status of CSBasicShape sent to server. More...
BOOL | mine
| Indicates whether shape is created by local user. More...
NSString * | ownerDisplayName
| Display name of user who created shape. More...

## Detailed Description

Base class for shapes that can be drawn on whiteboard surface.

Client doesn't need to use this class explicitly unless custom whiteboard is developed.

See also
  CSShape
  CSWhiteboardText
  CSCircleShape

## Property Documentation

- (NSUInteger) color
| read nonatomic assign

Color of shape in ARGB format.

Alpha is stored in most significant byte.

- (BOOL) mine
| read nonatomic assign

Indicates whether shape is created by local user.

- (NSString*) ownerDisplayName
| read nonatomic strong

Display name of user who created shape.

- (CSShapeSelectionStatus) selectionStatus
| read nonatomic assign

Status of CSBasicShape sent to server.

- (NSString*) shapeId
| read nonatomic strong

The shape ID associated with the particular shape object.

- (CGPoint) translation
| read write nonatomic assign

Geometric translation of shape.

- (CGFloat) width
| read nonatomic assign

Width of shape.

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

- CSBasicShape.h