Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Questionnaire

实现问卷功能：

  • 开始一份问卷
    • 发布问卷。
    • 停止问卷。
    • 获取房间内提交人数。
    • 发送问卷结果。
  • 问卷数据管理
    • 编辑或创建问卷。
    • 获取问卷列表。
    • 获取问卷详情。
    • 删除问卷。
    • 上传新问卷。
    • 下载问卷模板。
    • 下载问卷统计结果。

数量限制：

  • 单份问卷的最大题目数量：100

  • 每道单选题/多选题的选项个数最多 10 个，最少 2 个

  • 字数限制。注意一个非英文字符占用 2 个字符，如 "中文abc" 应算作 7 个字符。

    • 问卷名称：60
    • 选项内容：400
    • 题目内容：1000

Hierarchy

  • App
    • Questionnaire

Index

Constructors

Properties

Accessors

Other Methods

开始一份问卷 Methods

问卷数据管理 Methods

Constructors

constructor

Properties

Protected _eventEmitter

_eventEmitter: EventEmitter

app 事件总线

Protected name

name: string = 'App'

互动功能名称。 用于公共方法中区分不同的互动功能。

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

Accessors

Protected channelInfo

Protected chatInfo

  • 聊天室实例和数据。

    Returns ChatInfo

Protected isTransmitChannel

  • get isTransmitChannel(): boolean

  • 是否为转播主频道

    Returns boolean

Protected socketIOEventsHandlers

Other Methods

bindSocketIOEvents

  • bindSocketIOEvents(): void

  • 绑定 socket.io 原生事件，

    Returns void

Protected download

  • 下载文件。

    Parameters

    Returns Promise<void>

Protected formatApiUrl

  • formatApiUrl(path: string): string

  • 返回完整的 url 地址（api 域名相关）

    Parameters

    • path: string

      以 / 开头的相对路径

    Returns string

Protected formatChatUrl

  • formatChatUrl(path: string): string

  • 返回完整的 url 地址（chat 域名相关）

    Parameters

    • path: string

      以 / 开头的相对路径

    Returns string

Protected formatLiveUrl

  • formatLiveUrl(url: string): string

  • 返回完整的 url 地址（live 域名相关）

    Parameters

    • url: string

      以 / 开头的相对路径

    Returns string

Protected handleChatSingnaling

  • handleChatSingnaling(msg: { EVENT: QuestionnaireChatEvents }): void

  • 处理聊天室事件。 监听到聊天室事件后将消息内容传入该方法，将会触发对应的事件（需要使用 Questionnaire.on 进行监听）。

    Parameters

    • msg: { EVENT: QuestionnaireChatEvents }

      聊天室消息内容。

      • EVENT: QuestionnaireChatEvents

    Returns void

handleUpdateQuestionnaire

  • handleUpdateQuestionnaire(data: SocketUpdateData): void

  • 处理聊天室事件：同步问卷状态

    Parameters

    • data: SocketUpdateData

    Returns void

off

on

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

Protected trigger

开始一份问卷 Methods

getPushNum

  • getPushNum(questionnaireId: string): Promise<number>

  • 获取房间内提交人数。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<number>

    房间内已提交问卷的人数。

sendResult

  • sendResult(questionnaireId: string): Promise<void>

  • 发送问卷结果。 调用该方法后，聊天室将问卷结果发送至通知各端。如需显示问卷结果，需要在各端添加监听发送结果事件的逻辑。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<void>

start

  • start(questionnaireData: { desc: string; name: string; privacy: { content: string; required: EnableType }; questionnaireId: string; questions: Question[] }, sendTarget: { type: string }[]): Promise<void>

  • 发布问卷。

    Parameters

    • questionnaireData: { desc: string; name: string; privacy: { content: string; required: EnableType }; questionnaireId: string; questions: Question[] }

      问卷内容

      • desc: string
      • name: string
      • privacy: { content: string; required: EnableType }
        • content: string
        • required: EnableType
      • questionnaireId: string
      • questions: Question[]
    • sendTarget: { type: string }[]

      发送对象范围

    Returns Promise<void>

stop

  • stop(questionnaireId: string): Promise<void>

  • 停止问卷。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<void>

问卷数据管理 Methods

delete

  • delete(questionnaireId: string): Promise<void>

  • 删除问卷。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<void>

downloadStatistics

  • downloadStatistics(questionnaireId: string): Promise<void>

  • 下载问卷统计结果。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<void>

downloadTemplate

  • downloadTemplate(): Promise<void>

  • 下载问卷模板。

    Returns Promise<void>

getQuestionnaireDetail

  • 获取问卷详情。 包括问卷基本信息、问卷题目列表、提交结果统计数据（如果问卷已结束）。

    Parameters

    • questionnaireId: string

      问卷 id

    Returns Promise<QuestionnaireData>

    问卷详情。

getQuestionnaireList

getQuestionnairePageList

  • getQuestionnairePageList(queryParams: { pageNumber: number; pageSize: number }): Promise<BaseQuestionnaireData[]>

  • 获取问卷分页列表。

    Parameters

    • queryParams: { pageNumber: number; pageSize: number }

      分页查询参数

      • pageNumber: number
      • pageSize: number

    Returns Promise<BaseQuestionnaireData[]>

    问卷列表。

save

uploadTemplate

  • uploadTemplate(file: File): Promise<void>

Generated using TypeDoc