Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Polling.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingService+Polling.h
3// MobileRTC
4//
5// Created by Zoom on 2023/11/29.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <MobileRTC/MobileRTC.h>
10
11
16@interface MobileRTCPollingItem : NSObject
20- (NSString *_Nullable)getPollingID;
24- (NSString *_Nullable)getPollingName;
36- (NSInteger)getPollingQuestionCount;
40- (NSInteger)getTotalVotedUserCount;
44- (BOOL)isLibraryPolling;
45@end
46
51@interface MobileRTCPollingAnswerItem : NSObject
55- (NSString *_Nullable)getPollingID;
59- (NSString *_Nullable)getPollingQuestionID;
63- (NSString *_Nullable)getPollingSubQuestionID;
67- (NSString *_Nullable)getPollingAnswerID;
71- (NSString *_Nullable)getPollingAnswerName;
75- (NSString *_Nullable)getPollingAnsweredContent;
80- (BOOL)isChecked;
81@end
82
87@interface MobileRTCPollingQuestionItem : NSObject
91- (NSString *_Nullable)getPollingID;
95- (NSString *_Nullable)getPollingQuestionID;
99- (NSString *_Nullable)getPollingQuestionName;
107- (NSInteger)getAnsweredCount;
111- (BOOL)isRequired;
120@end
121
130- (NSString *_Nullable)getPollingID;
134- (NSString *_Nullable)getPollingQuestionID;
138- (NSString *_Nullable)getPollingSubQuestionID;
142- (NSString *_Nullable)getPollingAnswerID;
146- (NSString *_Nullable)getPollingAnswerName;
150- (NSInteger)getSelectedCount;
151@end
152
153
157@interface MobileRTCMeetingService (Polling)
158
159#pragma mark - for all users -
164- (BOOL)canDoPolling;
165
170- (NSString *_Nullable)getActivePollingID;
171
177- (NSArray <MobileRTCPollingQuestionItem *> * _Nullable)getPollingQuestionItemList:(NSString *_Nullable)pollingID;
178
184- (BOOL)canGetRightAnswerItemList:(NSString *_Nullable)pollingID;
185
191- (NSArray <MobileRTCPollingAnswerItem *> * _Nullable)getPollingRightAnswerItemList:(NSString *_Nullable)pollingID;
192
198- (BOOL)canShowAnswerResultList:(NSString *_Nullable)pollingID;
199
205- (NSArray <MobileRTCPollingAnswerResultItem *> * _Nullable)getPollingAnswerResultItemList:(NSString *_Nullable)pollingID;
206
212- (MobileRTCPollingItem * _Nullable)getPollingItemByID:(NSString *_Nullable)pollingID;
213
220- (NSString *_Nullable)getPollingQuestionImagePath:(NSString *_Nullable)pollingID questionID:(NSString *_Nullable)questionID;
221
228- (NSInteger)getQuestionCharactersMinLen:(NSString*_Nullable)pollingID questionID:(NSString*_Nullable)questionID;
229
236- (NSInteger)getQuestionCharactersMaxLen:(NSString*_Nullable)pollingID questionID:(NSString*_Nullable)questionID;
237
244- (BOOL)isQuestionCaseSensitive:(NSString *_Nullable)pollingID questionID:(NSString *_Nullable)questionID;
245
246#pragma mark - for host -
247
253- (BOOL)canAddPolling;
254
260
267- (BOOL)canEditPolling:(NSString *_Nullable)pollingID;
268
274- (MobileRTCSDKError)editPolling:(NSString *_Nullable)pollingID;
275
282- (BOOL)canDeletePolling:(NSString *_Nullable)pollingID;
283
289- (MobileRTCSDKError)deletePolling:(NSString *_Nullable)pollingID;
290
297- (BOOL)canDuplicatePolling:(NSString *_Nullable)pollingID;
298
304- (MobileRTCSDKError)duplicatePolling:(NSString *_Nullable)pollingID;
305
311- (BOOL)canViewPollingResultFromBrowser:(NSString *_Nullable)pollingID;
312
318- (MobileRTCSDKError)viewPollingResultFromBrowser:(NSString *_Nullable)pollingID;
319
324- (NSArray <MobileRTCPollingItem *> * _Nullable)getPollingItemList;
325
331- (BOOL)canStartPolling:(NSString *_Nullable)pollingID;
332
338- (MobileRTCSDKError)startPolling:(NSString *_Nullable)pollingID;
339
345- (MobileRTCSDKError)stopPolling:(NSString *_Nullable)pollingID;
346
352- (BOOL)canRestartPolling:(NSString *_Nullable)pollingID;
353
359- (MobileRTCSDKError)restartPolling:(NSString *_Nullable)pollingID;
360
366- (BOOL)canSharePollingResult:(NSString *_Nullable)pollingID;
367
373- (MobileRTCSDKError)startSharePollingResult:(NSString *_Nullable)pollingID;
374
380- (MobileRTCSDKError)stopSharePollingResult:(NSString *_Nullable)pollingID;
381
387- (MobileRTCSDKError)enableGetRightAnswerList:(BOOL)enable;
388
393- (BOOL)canDownloadResult;
394
400
401#pragma mark - for attendee -
402
410- (MobileRTCSDKError)setAnswerCheck:(MobileRTCPollingAnswerItem * _Nullable)answerItem check:(BOOL)check;
411
419- (MobileRTCSDKError)setAnswerContent:(MobileRTCPollingAnswerItem * _Nullable)answerItem answerText:(NSString *_Nullable)answerText;
420
426- (BOOL)canSubmitPolling:(NSString *_Nullable)pollingID;
427
433- (MobileRTCSDKError)submitPolling:(NSString *_Nullable)pollingID;
434@end
435
MobileRTCPollingStatus
Enumeration of polling statuses.
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCPollingQuestionType
Enumeration of polling question types. For more information, please visit https://support....
MobileRTCPollingType
Enumeration of polling types.
MobileRTCSDKError downLoadResult()
Download all stopped poll's result from browser.
BOOL canDownloadResult()
Determine if the host can download poll's result from browser.
BOOL canAddPolling()
Determine if the host can add polling.
MobileRTCSDKError addPolling()
Create polling in a web browser.
NSString *_Nullable getActivePollingID()
Get the active poll's ID.
BOOL canDoPolling()
Determine whether the current meeting can do the polling.
NSArray< MobileRTCPollingItem * > *_Nullable getPollingItemList()
Get the list of poll item.
NSString *_Nullable getPollingQuestionID()
Polling question ID.
NSString *_Nullable getPollingAnsweredContent()
Polling answered content.
NSString *_Nullable getPollingAnswerID()
Polling answer ID.
NSString *_Nullable getPollingID()
Polling ID of answer item.
NSString *_Nullable getPollingSubQuestionID()
Polling sub-question ID.
BOOL isChecked()
Determine if is checked.
NSString *_Nullable getPollingAnswerName()
Polling answer name.
Polling answer result item interface.
NSString *_Nullable getPollingQuestionID()
Polling queston ID.
NSString *_Nullable getPollingSubQuestionID()
Polling sub-queston ID.
NSInteger getSelectedCount()
Query how many participants selected this answer.
NSString *_Nullable getPollingID()
Polling ID of answer result item.
NSString *_Nullable getPollingAnswerID()
Polling answer ID.
NSString *_Nullable getPollingAnswerName()
Polling answer name.
NSString *_Nullable getPollingName()
Polling name.
NSInteger getPollingQuestionCount()
Polling question count.
MobileRTCPollingType getPollingType()
Polling type.
NSInteger getTotalVotedUserCount()
Count of total voted users.
NSString *_Nullable getPollingID()
Polling ID.
BOOL isLibraryPolling()
Determine if is library polling.
MobileRTCPollingStatus getPollingStatus()
Polling status.
Polling question item interface.
NSInteger getAnsweredCount()
The count of answered questions.
NSArray< MobileRTCPollingAnswerItem * > *_Nullable getPollingAnswerItemList()
Get the list of polling question or subquestion's answer.
NSString *_Nullable getPollingQuestionName()
Polling question name.
BOOL isRequired()
Determine if is required.
MobileRTCPollingQuestionType getPollingQuestionType()
Polling question type.
NSString *_Nullable getPollingQuestionID()
Polling question ID.
NSArray< MobileRTCPollingQuestionItem * > *_Nullable getPollingSubQuestionItemList()
Get the list of polling question's subquestion.
NSString *_Nullable getPollingID()
Polling ID of question item.