Class AnswerCard

答题卡功能

Hierarchy

App
- AnswerCard

Index

Constructors

constructor

Properties

Accessors

Other Methods

发起答题卡 Methods

题库管理 Methods

Constructors

constructor

new AnswerCard(): AnswerCard

Inherited from App.constructor

Returns AnswerCard

Properties

Protected _eventEmitter

_eventEmitter: EventEmitter

app 事件总线

Protected name

name: string = 'App'

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

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

Static wordCountLimit

wordCountLimit: WordCountLimit = ...

字数限制。创建或编辑题目时，对题目标题和选项字数长度都有限制。超出限制会导致调用接口返回错误。

Accessors

Protected channelInfo

get channelInfo(): ChannelInfo

频道信息

Returns ChannelInfo

Protected chatInfo

get chatInfo(): ChatInfo

聊天室实例和数据。

Returns ChatInfo

Protected isTransmitChannel

get isTransmitChannel(): boolean

是否为转播主频道

Returns boolean

Protected socketIOEventsHandlers

get socketIOEventsHandlers(): CustomEventHandlers

Returns CustomEventHandlers

Other Methods

bindSocketIOEvents

bindSocketIOEvents(): void

Inherited from App.bindSocketIOEvents

绑定 socket.io 原生事件，

Returns void

Protected download

download(url: string, params?: UniversalParams): Promise<void>

Inherited from App.download

下载文件。

Parameters
- url: string
  
  下载路径。
- Optional params: UniversalParams
  
  参数。
Returns Promise<void>

Protected formatApiUrl

formatApiUrl(path: string): string

Inherited from App.formatApiUrl

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

Parameters
- path: string
  
  以 / 开头的相对路径
Returns string

Protected formatChatUrl

formatChatUrl(path: string): string

Inherited from App.formatChatUrl

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

Parameters
- path: string
  
  以 / 开头的相对路径
Returns string

Protected formatLiveUrl

formatLiveUrl(url: string): string

Inherited from App.formatLiveUrl

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

Parameters
- url: string
  
  以 / 开头的相对路径
Returns string

Protected handleChatSingnaling

handleChatSingnaling(msg: { EVENT: AnswerCardChatEvents }): void

Overrides App.handleChatSingnaling

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

Parameters
- msg: { EVENT: AnswerCardChatEvents }
  
  聊天室消息内容。
  - EVENT: AnswerCardChatEvents
Returns void

off

off<K>(eventName: K, listener: Callback<AnswerCardEventMap[K]>): AnswerCard

Overrides App.off

取消订阅事件

Type parameters
- K: keyof AnswerCardEventMap
Parameters
- eventName: K
  
  事件名称
- listener: Callback<AnswerCardEventMap[K]>
  
  事件处理器
Returns AnswerCard

this

on

on<K>(eventName: K, listener: Callback<AnswerCardEventMap[K]>): AnswerCard

Overrides App.on

订阅事件。

Type parameters
- K: keyof AnswerCardEventMap
Parameters
- eventName: K
  
  事件名称
- listener: Callback<AnswerCardEventMap[K]>
  
  事件处理器
Returns AnswerCard

this

Protected sendSocket

sendSocket(message: UniversalParams, eventName?: string): Promise<SocketCallbackParams>

Inherited from App.sendSocket

发送聊天室消息。

Parameters
- message: UniversalParams
  
  消息内容。
- eventName: string = 'message'
Returns Promise<SocketCallbackParams>

Protected trigger

trigger(eventName: string, data?: UniversalParams): AnswerCard

Inherited from App.trigger

发布事件

Parameters
- eventName: string
  
  事件名称
- Optional data: UniversalParams
Returns AnswerCard

Static formatOptionsAndTipsToArray

formatOptionsAndTipsToArray<T>(data: T): { options: string[]; tips: string[] }

将对象格式的 options 和 tips 转换为数组格式的数据。

Type parameters
- T: OptionsAndTips<T>
Parameters
- data: T
Returns { options: string[]; tips: string[] }
- options: string[]
- tips: string[]

Static formatOptionsAndTipsToObject

formatOptionsAndTipsToObject(__namedParameters: { options: string[]; tips?: string[] }): OptionsAndTips

将数组格式的 options 和 tips 转换为对象格式的数据。

Parameters
- __namedParameters: { options: string[]; tips?: string[] }
  - options: string[]
  - Optional tips?: string[]
Returns OptionsAndTips

发起答题卡 Methods

getOngoingStatus

getOngoingStatus(): Promise<OngoingStatus>

获取房间内答题情况。

Returns Promise<OngoingStatus>

getQuestionStatistics

getQuestionStatistics(questionId: string): Promise<Statistics>

获取答题统计数据。

Parameters
- questionId: string
  
  答题卡 id
Returns Promise<Statistics>

答题统计数据

getRemainingTime

getRemainingTime(): Promise<number>

获取答题卡剩余时间。

Returns Promise<number>

剩余时间。单位：秒。

sendResult

sendResult(result: { question: QuestionContentBasic; statistics: Statistics }): Promise<void>

发送答题结果。

Parameters
- result: { question: QuestionContentBasic; statistics: Statistics }
  
  结果
  - question: QuestionContentBasic
    
    题目内容
  - statistics: Statistics
    
    答题统计结果
Returns Promise<void>

start

start(startOptions: { question: QuestionContent; setting: QuestionSetting }): Promise<string>

开始答题。

Parameters
- startOptions: { question: QuestionContent; setting: QuestionSetting }
  
  开始答题的内容
  - question: QuestionContent
    
    题目内容
  - setting: QuestionSetting
    
    答题设置
Returns Promise<string>

questionId 答题卡id。

stop

stop(questionId: string): Promise<void>

结束答题。

Parameters
- questionId: string
  
  答题卡 id
Returns Promise<void>

题库管理 Methods

applyTemplate

applyTemplate(templateId: string): Promise<{ questions: QuestionContent[]; templateId: string }>

应用题库。

Parameters
- templateId: string
  
  题库模板 id
Returns Promise<{ questions: QuestionContent[]; templateId: string }>

deleteQuestion

deleteQuestion(questionId: string): Promise<void>

删除答题卡。操作会更新到当前在使用的题库列表。

Parameters
- questionId: string
  
  答题卡 id
Returns Promise<void>

deleteTemplate

deleteTemplate(templateId: string): Promise<void>

删除题库。

Parameters
- templateId: string
  
  题库模板 id
Returns Promise<void>

downloadTemplate

downloadTemplate(templateId?: string): Promise<void>

下载题库或模板。不传入参数时，默认下载模板。

Parameters
- Optional templateId: string
Returns Promise<void>

duplicateCheckTemplate

duplicateCheckTemplate(fileName: string): Promise<boolean>

检查题库是否已存在。

Parameters
- fileName: string
  
  题库模板文件名。
Returns Promise<boolean>

getQuestionList

getQuestionList(): Promise<{ questions: QuestionContent[]; templateId: string }>

获取当前正在使用的的题目列表。

Returns Promise<{ questions: QuestionContent[]; templateId: string }>

题目列表和题库 id

getTemplateList

getTemplateList(params?: { page?: number; pageSize?: number }): Promise<TemplateList>

获取题库列表。

Parameters
- Optional params: { page?: number; pageSize?: number }
  - Optional page?: number
  - Optional pageSize?: number
Returns Promise<TemplateList>

题库总条数、当前页码，以及题库列表。

saveQuestion

saveQuestion(question: QuestionContent): Promise<string>

创建或编辑答题卡。操作会更新到当前在使用的题库列表。

Parameters
- question: QuestionContent
  
  答题卡内容。
Returns Promise<string>

questionId 答题卡 id

uploadTemplate

uploadTemplate(file: File, templateId?: string): Promise<void>

上传题库。传入 templateId 参数时，会将指定 templateId 的题库数据更新为新上传题库中的数据；否则，将上传为一个新题库。

Parameters
- file: File
  
  题库模板文件对象。
- Optional templateId: string
Returns Promise<void>

Generated using TypeDoc