zoom_meeting_qa

Zoom Meeting Q&A
Description:
  • Zoom Meeting Q&A
Source:
Parameters:
Name Type Description
onAddQuestion function Callback event of adding question
onReceiveQuestion function Callback event of receiving question
onDeleteQuestions function Callback event of deleting question(s)
onQuestionMarkedAsDismissed function Callback event of marking question as dismissed
onReopenQuestion function Callback event of reopening question
onUserLivingReply function Callback event of user answering live
onRevokeVoteupQuestion function Callback event of revoking voting up question
onAddAnswer function Callback event of adding answer
onReceiveAnswer function Callback event of receiving answer
onDeleteAnswers function Callback event of deleting answer(s)
onVoteupQuestion function Callback event of voting up question
onUserEndLiving function Callback event of end of user answering live
Returns:
Type
ZoomMeetingQA
Description:
  • Zoom Meeting Q&A
Source:
Parameters:
Name Type Description
onAddQuestion function Callback event of adding question
onReceiveQuestion function Callback event of receiving question
onDeleteQuestions function Callback event of deleting question(s)
onQuestionMarkedAsDismissed function Callback event of marking question as dismissed
onReopenQuestion function Callback event of reopening question
onUserLivingReply function Callback event of user answering live
onRevokeVoteupQuestion function Callback event of revoking voting up question
onAddAnswer function Callback event of adding answer
onReceiveAnswer function Callback event of receiving answer
onDeleteAnswers function Callback event of deleting answer(s)
onVoteupQuestion function Callback event of voting up question
onUserEndLiving function Callback event of end of user answering live
Returns:
Type
ZoomMeetingQA

Methods

(inner) AnswerQuestionPrivateWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question to the question sender privately.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPrivateWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question to the question sender privately.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPublicWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question publicly.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPublicWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question publicly.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteAnswer(answerID) → {Number}

Description:
  • The host deletes the answerID.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteAnswer(answerID) → {Number}

Description:
  • The host deletes the answerID.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteQuestion(questionID) → {Number}

Description:
  • The host deletes the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteQuestion(questionID) → {Number}

Description:
  • The host deletes the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DismissQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host dismisses the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DismissQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host dismisses the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EndLiving(questionID) → {Number}

Description:
  • Set the question can not be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EndLiving(questionID) → {Number}

Description:
  • Set the question can not be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) GetAllQuestionList() → {Array}

Description:
  • Get the list of all the questions.
Source:
Returns:
If the function succeeds, the return value is a list of question item objects, each with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Array

(inner) GetAllQuestionList() → {Array}

Description:
  • Get the list of all the questions.
Source:
Returns:
If the function succeeds, the return value is a list of question item objects, each with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Array

(inner) GetAnswer(answerID) → {Object}

Description:
  • Get a certain answer.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is an answer item object with the following properties: - timeStamp: The timestamp of the answer - text: The text of the answer - senderName: The sender's name of the answer - questionID: The related question's id of the answer - answerID: The answer id - isPrivate: Whether the answer is private - isLiveAnswer: Whether the answer is live - isSenderMyself: Whether the answer's sender is the user himself
Type
Object

(inner) GetAnswer(answerID) → {Object}

Description:
  • Get a certain answer.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is an answer item object with the following properties: - timeStamp: The timestamp of the answer - text: The text of the answer - senderName: The sender's name of the answer - questionID: The related question's id of the answer - answerID: The answer id - isPrivate: Whether the answer is private - isLiveAnswer: Whether the answer is live - isSenderMyself: Whether the answer's sender is the user himself
Type
Object

(inner) GetQuestion(questionID) → {Object}

Description:
  • Get a certain question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is a question item object with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Object

(inner) GetQuestion(questionID) → {Object}

Description:
  • Get a certain question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is a question item object with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Object

(inner) ReopenQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host reopens the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) ReopenQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host reopens the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetOnAddAnswerCB(onAddAnswer) → {Boolean}

Description:
  • Set onAddAnswer callback.
Source:
Parameters:
Name Type Description
onAddAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnAddAnswerCB(onAddAnswer) → {Boolean}

Description:
  • Set onAddAnswer callback.
Source:
Parameters:
Name Type Description
onAddAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnAddQuestionCB(onAddQuestion) → {Boolean}

Description:
  • Set onAddQuestion callback.
Source:
Parameters:
Name Type Description
onAddQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnAddQuestionCB(onAddQuestion) → {Boolean}

Description:
  • Set onAddQuestion callback.
Source:
Parameters:
Name Type Description
onAddQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteAnswersCB(onDeleteAnswers) → {Boolean}

Description:
  • Set onDeleteAnswers callback.
Source:
Parameters:
Name Type Description
onDeleteAnswers function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteAnswersCB(onDeleteAnswers) → {Boolean}

Description:
  • Set onDeleteAnswers callback.
Source:
Parameters:
Name Type Description
onDeleteAnswers function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteQuestionsCB(onDeleteQuestions) → {Boolean}

Description:
  • Set onDeleteQuestions callback.
Source:
Parameters:
Name Type Description
onDeleteQuestions function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteQuestionsCB(onDeleteQuestions) → {Boolean}

Description:
  • Set onDeleteQuestions callback.
Source:
Parameters:
Name Type Description
onDeleteQuestions function
Returns:
true or false
Type
Boolean

(inner) SetOnQuestionMarkedAsDismissedCB(onQuestionMarkedAsDismissed) → {Boolean}

Description:
  • Set onQuestionMarkedAsDismissed callback.
Source:
Parameters:
Name Type Description
onQuestionMarkedAsDismissed function
Returns:
true or false
Type
Boolean

(inner) SetOnQuestionMarkedAsDismissedCB(onQuestionMarkedAsDismissed) → {Boolean}

Description:
  • Set onQuestionMarkedAsDismissed callback.
Source:
Parameters:
Name Type Description
onQuestionMarkedAsDismissed function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveAnswerCB(onReceiveAnswer) → {Boolean}

Description:
  • Set onReceiveAnswer callback.
Source:
Parameters:
Name Type Description
onReceiveAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveAnswerCB(onReceiveAnswer) → {Boolean}

Description:
  • Set onReceiveAnswer callback.
Source:
Parameters:
Name Type Description
onReceiveAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveQuestionCB(onReceiveQuestion) → {Boolean}

Description:
  • Set onReceiveQuestion callback.
Source:
Parameters:
Name Type Description
onReceiveQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveQuestionCB(onReceiveQuestion) → {Boolean}

Description:
  • Set onReceiveQuestion callback.
Source:
Parameters:
Name Type Description
onReceiveQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReopenQuestionCB(onReopenQuestion) → {Boolean}

Description:
  • Set onReopenQuestion callback.
Source:
Parameters:
Name Type Description
onReopenQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReopenQuestionCB(onReopenQuestion) → {Boolean}

Description:
  • Set onReopenQuestion callback.
Source:
Parameters:
Name Type Description
onReopenQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnRevokeVoteupQuestionCB(onRevokeVoteupQuestion) → {Boolean}

Description:
  • Set onRevokeVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onRevokeVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnRevokeVoteupQuestionCB(onRevokeVoteupQuestion) → {Boolean}

Description:
  • Set onRevokeVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onRevokeVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnUserEndLivingCB(onUserEndLiving) → {Boolean}

Description:
  • Set onUserEndLiving callback.
Source:
Parameters:
Name Type Description
onUserEndLiving function
Returns:
true or false
Type
Boolean

(inner) SetOnUserEndLivingCB(onUserEndLiving) → {Boolean}

Description:
  • Set onUserEndLiving callback.
Source:
Parameters:
Name Type Description
onUserEndLiving function
Returns:
true or false
Type
Boolean

(inner) SetOnUserLivingReplyCB(onUserLivingReply) → {Boolean}

Description:
  • Set onUserLivingReply callback.
Source:
Parameters:
Name Type Description
onUserLivingReply function
Returns:
true or false
Type
Boolean

(inner) SetOnUserLivingReplyCB(onUserLivingReply) → {Boolean}

Description:
  • Set onUserLivingReply callback.
Source:
Parameters:
Name Type Description
onUserLivingReply function
Returns:
true or false
Type
Boolean

(inner) SetOnVoteupQuestionCB(onVoteupQuestion) → {Boolean}

Description:
  • Set onVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnVoteupQuestionCB(onVoteupQuestion) → {Boolean}

Description:
  • Set onVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) StartLiving(questionID) → {Number}

Description:
  • Set the question can be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartLiving(questionID) → {Number}

Description:
  • Set the question can be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) VoteupQuestionWithQuestionID(questionID, enabled) → {Number}

Description:
  • Vote up or revoke voting up the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
enabled Boolean TRUE indicates to vote up, FALSE indicates to revoke voting up
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) VoteupQuestionWithQuestionID(questionID, enabled) → {Number}

Description:
  • Vote up or revoke voting up the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
enabled Boolean TRUE indicates to vote up, FALSE indicates to revoke voting up
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onAddAnswer

Description:
  • Callback event of adding answer.
Source:
Parameters:
Name Type Description
answerID String The answer id
bSuccess Boolean Add answer successfully or not

onAddAnswer

Description:
  • Callback event of adding answer.
Source:
Parameters:
Name Type Description
answerID String The answer id
bSuccess Boolean Add answer successfully or not

onAddQuestion

Description:
  • Callback event of adding question.
Source:
Parameters:
Name Type Description
questionID String The question id
bSuccess Boolean Add question successfully or not

onAddQuestion

Description:
  • Callback event of adding question.
Source:
Parameters:
Name Type Description
questionID String The question id
bSuccess Boolean Add question successfully or not

onDeleteAnswers

Description:
  • Callback event of deleting answer(s).
Source:
Parameters:
Name Type Description
answer Array The list of answer ids

onDeleteAnswers

Description:
  • Callback event of deleting answer(s).
Source:
Parameters:
Name Type Description
answer Array The list of answer ids

onDeleteQuestions

Description:
  • Callback event of deleting question(s).
Source:
Parameters:
Name Type Description
questions Array The list of question ids

onDeleteQuestions

Description:
  • Callback event of deleting question(s).
Source:
Parameters:
Name Type Description
questions Array The list of question ids

onQuestionMarkedAsDismissed

Description:
  • Callback event of marking question as dismissed.
Source:
Parameters:
Name Type Description
questionID String The question id

onQuestionMarkedAsDismissed

Description:
  • Callback event of marking question as dismissed.
Source:
Parameters:
Name Type Description
questionID String The question id

onReceiveAnswer

Description:
  • Callback event of receiving answer.
Source:
Parameters:
Name Type Description
answerID String The answer id

onReceiveAnswer

Description:
  • Callback event of receiving answer.
Source:
Parameters:
Name Type Description
answerID String The answer id

onReceiveQuestion

Description:
  • Callback event of receiving question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReceiveQuestion

Description:
  • Callback event of receiving question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReopenQuestion

Description:
  • Callback event of reopening question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReopenQuestion

Description:
  • Callback event of reopening question.
Source:
Parameters:
Name Type Description
questionID String The question id

onRevokeVoteupQuestion

Description:
  • Callback event of revoking voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onRevokeVoteupQuestion

Description:
  • Callback event of revoking voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onUserEndLiving

Description:
  • Callback event of end of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserEndLiving

Description:
  • Callback event of end of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserLivingReply

Description:
  • Callback event of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserLivingReply

Description:
  • Callback event of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onVoteupQuestion

Description:
  • Callback event of voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onVoteupQuestion

Description:
  • Callback event of voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not
Zoom Meeting Q&A
Description:
  • Zoom Meeting Q&A
Source:
Parameters:
Name Type Description
onAddQuestion function Callback event of adding question
onReceiveQuestion function Callback event of receiving question
onDeleteQuestions function Callback event of deleting question(s)
onQuestionMarkedAsDismissed function Callback event of marking question as dismissed
onReopenQuestion function Callback event of reopening question
onUserLivingReply function Callback event of user answering live
onRevokeVoteupQuestion function Callback event of revoking voting up question
onAddAnswer function Callback event of adding answer
onReceiveAnswer function Callback event of receiving answer
onDeleteAnswers function Callback event of deleting answer(s)
onVoteupQuestion function Callback event of voting up question
onUserEndLiving function Callback event of end of user answering live
Returns:
Type
ZoomMeetingQA
Description:
  • Zoom Meeting Q&A
Source:
Parameters:
Name Type Description
onAddQuestion function Callback event of adding question
onReceiveQuestion function Callback event of receiving question
onDeleteQuestions function Callback event of deleting question(s)
onQuestionMarkedAsDismissed function Callback event of marking question as dismissed
onReopenQuestion function Callback event of reopening question
onUserLivingReply function Callback event of user answering live
onRevokeVoteupQuestion function Callback event of revoking voting up question
onAddAnswer function Callback event of adding answer
onReceiveAnswer function Callback event of receiving answer
onDeleteAnswers function Callback event of deleting answer(s)
onVoteupQuestion function Callback event of voting up question
onUserEndLiving function Callback event of end of user answering live
Returns:
Type
ZoomMeetingQA

Methods

(inner) AnswerQuestionPrivateWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question to the question sender privately.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPrivateWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question to the question sender privately.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPublicWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question publicly.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) AnswerQuestionPublicWithQuestionID(questionID, questionContent) → {Number}

Description:
  • The host answers the question publicly.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
questionContent String Specify the content of the answer
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteAnswer(answerID) → {Number}

Description:
  • The host deletes the answerID.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteAnswer(answerID) → {Number}

Description:
  • The host deletes the answerID.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteQuestion(questionID) → {Number}

Description:
  • The host deletes the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DeleteQuestion(questionID) → {Number}

Description:
  • The host deletes the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DismissQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host dismisses the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DismissQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host dismisses the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EndLiving(questionID) → {Number}

Description:
  • Set the question can not be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EndLiving(questionID) → {Number}

Description:
  • Set the question can not be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) GetAllQuestionList() → {Array}

Description:
  • Get the list of all the questions.
Source:
Returns:
If the function succeeds, the return value is a list of question item objects, each with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Array

(inner) GetAllQuestionList() → {Array}

Description:
  • Get the list of all the questions.
Source:
Returns:
If the function succeeds, the return value is a list of question item objects, each with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Array

(inner) GetAnswer(answerID) → {Object}

Description:
  • Get a certain answer.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is an answer item object with the following properties: - timeStamp: The timestamp of the answer - text: The text of the answer - senderName: The sender's name of the answer - questionID: The related question's id of the answer - answerID: The answer id - isPrivate: Whether the answer is private - isLiveAnswer: Whether the answer is live - isSenderMyself: Whether the answer's sender is the user himself
Type
Object

(inner) GetAnswer(answerID) → {Object}

Description:
  • Get a certain answer.
Source:
Parameters:
Name Type Description
answerID String Specify the answer id
Returns:
If the function succeeds, the return value is an answer item object with the following properties: - timeStamp: The timestamp of the answer - text: The text of the answer - senderName: The sender's name of the answer - questionID: The related question's id of the answer - answerID: The answer id - isPrivate: Whether the answer is private - isLiveAnswer: Whether the answer is live - isSenderMyself: Whether the answer's sender is the user himself
Type
Object

(inner) GetQuestion(questionID) → {Object}

Description:
  • Get a certain question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is a question item object with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Object

(inner) GetQuestion(questionID) → {Object}

Description:
  • Get a certain question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is a question item object with the following properties: - timeStamp: The timestamp of the question - upvoteNum: The number of the up_voters of the question - text: The text of the question - senderName: The sender's name of the question - questionID: The question id - isAnonymous: Whether the question is anonymous - isMarkedAsAnswered: Whether the question is marked as answered - isMarkedAsDismissed: Whether the question is marked as dismissed - isSenderMyself: Whether the question's sender is the user himself - isMySelfUpvoted: Whether the user himself is an up_voter of the question - hasLiveAnswers: Whether the question has live answers - hasTextAnswers: Whether the question has text answers - amILiveAnswering: Whether the user himself is answering the question live - liveAnswerName: All the users' names who answers the question live - isLiveAnswering: Whether the question is being answered live - answerList: The list of all the answers to the question
Type
Object

(inner) ReopenQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host reopens the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) ReopenQuestionWithQuestionID(questionID) → {Number}

Description:
  • The host reopens the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetOnAddAnswerCB(onAddAnswer) → {Boolean}

Description:
  • Set onAddAnswer callback.
Source:
Parameters:
Name Type Description
onAddAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnAddAnswerCB(onAddAnswer) → {Boolean}

Description:
  • Set onAddAnswer callback.
Source:
Parameters:
Name Type Description
onAddAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnAddQuestionCB(onAddQuestion) → {Boolean}

Description:
  • Set onAddQuestion callback.
Source:
Parameters:
Name Type Description
onAddQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnAddQuestionCB(onAddQuestion) → {Boolean}

Description:
  • Set onAddQuestion callback.
Source:
Parameters:
Name Type Description
onAddQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteAnswersCB(onDeleteAnswers) → {Boolean}

Description:
  • Set onDeleteAnswers callback.
Source:
Parameters:
Name Type Description
onDeleteAnswers function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteAnswersCB(onDeleteAnswers) → {Boolean}

Description:
  • Set onDeleteAnswers callback.
Source:
Parameters:
Name Type Description
onDeleteAnswers function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteQuestionsCB(onDeleteQuestions) → {Boolean}

Description:
  • Set onDeleteQuestions callback.
Source:
Parameters:
Name Type Description
onDeleteQuestions function
Returns:
true or false
Type
Boolean

(inner) SetOnDeleteQuestionsCB(onDeleteQuestions) → {Boolean}

Description:
  • Set onDeleteQuestions callback.
Source:
Parameters:
Name Type Description
onDeleteQuestions function
Returns:
true or false
Type
Boolean

(inner) SetOnQuestionMarkedAsDismissedCB(onQuestionMarkedAsDismissed) → {Boolean}

Description:
  • Set onQuestionMarkedAsDismissed callback.
Source:
Parameters:
Name Type Description
onQuestionMarkedAsDismissed function
Returns:
true or false
Type
Boolean

(inner) SetOnQuestionMarkedAsDismissedCB(onQuestionMarkedAsDismissed) → {Boolean}

Description:
  • Set onQuestionMarkedAsDismissed callback.
Source:
Parameters:
Name Type Description
onQuestionMarkedAsDismissed function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveAnswerCB(onReceiveAnswer) → {Boolean}

Description:
  • Set onReceiveAnswer callback.
Source:
Parameters:
Name Type Description
onReceiveAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveAnswerCB(onReceiveAnswer) → {Boolean}

Description:
  • Set onReceiveAnswer callback.
Source:
Parameters:
Name Type Description
onReceiveAnswer function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveQuestionCB(onReceiveQuestion) → {Boolean}

Description:
  • Set onReceiveQuestion callback.
Source:
Parameters:
Name Type Description
onReceiveQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReceiveQuestionCB(onReceiveQuestion) → {Boolean}

Description:
  • Set onReceiveQuestion callback.
Source:
Parameters:
Name Type Description
onReceiveQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReopenQuestionCB(onReopenQuestion) → {Boolean}

Description:
  • Set onReopenQuestion callback.
Source:
Parameters:
Name Type Description
onReopenQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnReopenQuestionCB(onReopenQuestion) → {Boolean}

Description:
  • Set onReopenQuestion callback.
Source:
Parameters:
Name Type Description
onReopenQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnRevokeVoteupQuestionCB(onRevokeVoteupQuestion) → {Boolean}

Description:
  • Set onRevokeVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onRevokeVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnRevokeVoteupQuestionCB(onRevokeVoteupQuestion) → {Boolean}

Description:
  • Set onRevokeVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onRevokeVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnUserEndLivingCB(onUserEndLiving) → {Boolean}

Description:
  • Set onUserEndLiving callback.
Source:
Parameters:
Name Type Description
onUserEndLiving function
Returns:
true or false
Type
Boolean

(inner) SetOnUserEndLivingCB(onUserEndLiving) → {Boolean}

Description:
  • Set onUserEndLiving callback.
Source:
Parameters:
Name Type Description
onUserEndLiving function
Returns:
true or false
Type
Boolean

(inner) SetOnUserLivingReplyCB(onUserLivingReply) → {Boolean}

Description:
  • Set onUserLivingReply callback.
Source:
Parameters:
Name Type Description
onUserLivingReply function
Returns:
true or false
Type
Boolean

(inner) SetOnUserLivingReplyCB(onUserLivingReply) → {Boolean}

Description:
  • Set onUserLivingReply callback.
Source:
Parameters:
Name Type Description
onUserLivingReply function
Returns:
true or false
Type
Boolean

(inner) SetOnVoteupQuestionCB(onVoteupQuestion) → {Boolean}

Description:
  • Set onVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) SetOnVoteupQuestionCB(onVoteupQuestion) → {Boolean}

Description:
  • Set onVoteupQuestion callback.
Source:
Parameters:
Name Type Description
onVoteupQuestion function
Returns:
true or false
Type
Boolean

(inner) StartLiving(questionID) → {Number}

Description:
  • Set the question can be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartLiving(questionID) → {Number}

Description:
  • Set the question can be answered live.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) VoteupQuestionWithQuestionID(questionID, enabled) → {Number}

Description:
  • Vote up or revoke voting up the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
enabled Boolean TRUE indicates to vote up, FALSE indicates to revoke voting up
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) VoteupQuestionWithQuestionID(questionID, enabled) → {Number}

Description:
  • Vote up or revoke voting up the question.
Source:
Parameters:
Name Type Description
questionID String Specify the question id
enabled Boolean TRUE indicates to vote up, FALSE indicates to revoke voting up
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onAddAnswer

Description:
  • Callback event of adding answer.
Source:
Parameters:
Name Type Description
answerID String The answer id
bSuccess Boolean Add answer successfully or not

onAddAnswer

Description:
  • Callback event of adding answer.
Source:
Parameters:
Name Type Description
answerID String The answer id
bSuccess Boolean Add answer successfully or not

onAddQuestion

Description:
  • Callback event of adding question.
Source:
Parameters:
Name Type Description
questionID String The question id
bSuccess Boolean Add question successfully or not

onAddQuestion

Description:
  • Callback event of adding question.
Source:
Parameters:
Name Type Description
questionID String The question id
bSuccess Boolean Add question successfully or not

onDeleteAnswers

Description:
  • Callback event of deleting answer(s).
Source:
Parameters:
Name Type Description
answer Array The list of answer ids

onDeleteAnswers

Description:
  • Callback event of deleting answer(s).
Source:
Parameters:
Name Type Description
answer Array The list of answer ids

onDeleteQuestions

Description:
  • Callback event of deleting question(s).
Source:
Parameters:
Name Type Description
questions Array The list of question ids

onDeleteQuestions

Description:
  • Callback event of deleting question(s).
Source:
Parameters:
Name Type Description
questions Array The list of question ids

onQuestionMarkedAsDismissed

Description:
  • Callback event of marking question as dismissed.
Source:
Parameters:
Name Type Description
questionID String The question id

onQuestionMarkedAsDismissed

Description:
  • Callback event of marking question as dismissed.
Source:
Parameters:
Name Type Description
questionID String The question id

onReceiveAnswer

Description:
  • Callback event of receiving answer.
Source:
Parameters:
Name Type Description
answerID String The answer id

onReceiveAnswer

Description:
  • Callback event of receiving answer.
Source:
Parameters:
Name Type Description
answerID String The answer id

onReceiveQuestion

Description:
  • Callback event of receiving question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReceiveQuestion

Description:
  • Callback event of receiving question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReopenQuestion

Description:
  • Callback event of reopening question.
Source:
Parameters:
Name Type Description
questionID String The question id

onReopenQuestion

Description:
  • Callback event of reopening question.
Source:
Parameters:
Name Type Description
questionID String The question id

onRevokeVoteupQuestion

Description:
  • Callback event of revoking voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onRevokeVoteupQuestion

Description:
  • Callback event of revoking voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onUserEndLiving

Description:
  • Callback event of end of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserEndLiving

Description:
  • Callback event of end of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserLivingReply

Description:
  • Callback event of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onUserLivingReply

Description:
  • Callback event of user answering live.
Source:
Parameters:
Name Type Description
questionID String The question id

onVoteupQuestion

Description:
  • Callback event of voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not

onVoteupQuestion

Description:
  • Callback event of voting up question.
Source:
Parameters:
Name Type Description
questionID String The vote question id
isChanged Boolean The order of the question in question list is changed or not