Home>CVC>Specification |
Variables and Messages
for Virtual Classroom |
MsgID:0 |
Description: Login Information |
Example:Msg0.XML |
Variables: |
- FirstName
- LastName
- IsTeacher (True or False)
- passwd
|
MsgID:1 |
Description: Result of authentication |
Example:Msg1.XML |
Variables: |
- Success (True of False)
- ServerIP ( Return the IP of VC Server if Success=True,
otherwise null)
|
MsgID:2 |
Description: List of available courses |
Example:Msg2.XML |
Variables: |
- CourseNum ( total # of available courses e.g. N)
- Course{i}(i=0,1,2......N-1) e.g. Course0, Course1......
|
MsgID:3 |
Description: Course Selected |
Example:Msg3.XML |
Variables: |
- CourseSelected ( the course name which is chosen by user)
|
MsgID:4 |
Description: Class Roster |
Example:Msg4.XML |
Variables: |
- TeacherFirst [note: Teacher's First Name]
- TeacherLast [note: Teacher's Last Name]
- CourseNo
- StudentCount ( total # of students e.g. N)
- FirstName{i}(i=0,1,2......N-1) e.g. FirstName0,
FirstName1......
- LastName{i}(i=0,1,2......N-1) e.g. LastName0, LastName1.....
- State{i}(i=0,1,2......N-1) e.g. State0, State1.......
|
MsgID:5 |
Description: Changing State |
Example:Msg5.XML |
Variables: |
- CourseNo
- IsTeacher ( True or False)
- FirstName
- LastName
- State
|
MsgID:6 |
Description: Operation Acknowledge |
Example:Msg6.XML |
Variables: |
- Operation ( Success or Failure)
|
MsgID:7 |
Description: URLs Pushed |
Example:Msg7.XML |
Variables: |
- MainURL
- AudioURL
- VideoURL
- ForTeacherOnly( True or False)[ note: student is allowed to
push page only to teacher ]
|
MsgID:8 |
Description: Instant Message |
Example:Msg8.XML |
Variables: |
- FromFirstName [note: sender's first name]
- FromLastName [note: sender's last name ]
- ToFirstName [note: receiver's first name ]
- ToLastName [note: receiver's last name ]
- MsgColor
- IsAudio ( True or False)
- IsBroadcase( True of False) [note: when true, ToFirstName and
ToLastName will be null)
|
MsgID:9 |
Description: Whiteboard Drawing |
Example:Msg9.XML |
Variables: |
- ShapeNum ( total # of shapes on the board e.g. N)
- ShapeType{i}(i=0,1,2......N-1) e.g. ShapeType0,
ShapeType1.....[note: there are four kinds of shape types:
0:Line;1:Rectangle;2:Ellipse;3:RoundRect;4:Text;]
If ShapeType is 4: Text, it will followed by
- PosX{i}(i=0,1,2......N-1) e.g. PosX0, PosX1.......
- PosY{i}(i=0,1,2......N-1) e.g. PosY0, PosY1.......
- TextStr{i}(i=0,1,2......N-1) e.g. TextStr0, TextStr1.......
Otherwise, for other shapes:
- LeftTopX{i} (i=0,1,2......N-1) e.g. LeftTopX0,
LeftTopX1.......
- LeftTopY{i} (i=0,1,2......N-1) e.g. LeftTopY0,
LeftTopY1.......
- RightBottomX{i}(i=0,1,2......N-1) e.g. RightBottomX0,
RightBottomX1.......
- RightBottomY{i}(i=0,1,2......N-1) e.g. RightBottomY0,
RightBottomY1......
- LineStyle{i}(i=0,1,2......N-1) e.g. LineStyle0,
LineStyle1......
- LineColor{i}(i=0,1,2......N-1) e.g. LineColor0,
LineColor1......
- LineWidth{i}(i=0,1,2......N-1) e.g. LineWidth0,
LineWidth1......
- BrushStyle{i}(i=0,1,2......N-1) e.g. BrushStyle0,
BrushStyle1......
- BrushColor{i}(i=0,1,2......N-1) e.g. BrushColor0,
BrushColor1......
|
MsgID:10 |
Description: System Error Message |
Example:Msg10.XML |
Variables: |
- MsgText [note: the content of message]
- toFristName
- toLastName
- ForceLogout (True of False) [note: in case of fatal errors,
set true forcing client to quit]
|
Updated: 02/12/2004
|
|
|