ZoomSDKPollingController.h

Go to the documentation of this file.

 
 
#import <Foundation/Foundation.h>
#import <ZoomSDK/ZoomSDKErrors.h>
 
NS_ASSUME_NONNULL_BEGIN
 
typedef enum
{
    ZoomSDKPollingStatus_Initial,
    ZoomSDKPollingStatus_Started,
    ZoomSDKPollingStatus_ShareResult,
    ZoomSDKPollingStatus_Stopped
}ZoomSDKPollingStatus;
 
 
typedef enum
{
    ZoomSDKPollingType_Unknown = 0,
    ZoomSDKPollingType_Poll,
    ZoomSDKPollingType_Quiz
}ZoomSDKPollingType;
 
 
typedef enum
{
    ZoomSDKPollingQuestionType_Unknown = 0,
    ZoomSDKPollingQuestionType_Single,
    ZoomSDKPollingQuestionType_Multi,
    ZoomSDKPollingQuestionType_Matching,
    ZoomSDKPollingQuestionType_RankOrder,
    ZoomSDKPollingQuestionType_ShortAnswer,
    ZoomSDKPollingQuestionType_LongAnswer,
    ZoomSDKPollingQuestionType_FillBlank,
    ZoomSDKPollingQuestionType_NPS,
    ZoomSDKPollingQuestionType_Dropdown
}ZoomSDKPollingQuestionType;
 
 
typedef enum
{
    ZoomSDKPollingActionType_Unknown = 0,
    ZoomSDKPollingActionType_Start,
    ZoomSDKPollingActionType_Stop,
    ZoomSDKPollingActionType_ShareResult,
    ZoomSDKPollingActionType_StopShareResult,
    ZoomSDKPollingActionType_Duplicate,
    ZoomSDKPollingActionType_Delete,
    ZoomSDKPollingActionType_Submit,
    ZoomSDKPollingActionType_Error
}ZoomSDKPollingActionType;
 
@interface ZoomSDKPollingItem : NSObject
@property(nonatomic, copy, readonly, nullable) NSString* pollingID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingName;
@property(nonatomic, assign, readonly) ZoomSDKPollingType pollingType;
@property(nonatomic, assign, readonly) ZoomSDKPollingStatus pollingStatus;
@property(nonatomic, assign, readonly) unsigned int pollingQuestionCount;
@property(nonatomic, assign, readonly) unsigned int totalVotedUserCount;
@property(nonatomic, assign, readonly) BOOL isLibraryPolling;
@end
 
 
 
@interface ZoomSDKPollingAnswerItem : NSObject
@property(nonatomic, copy, readonly, nullable) NSString* pollingID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingQuestionID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingSubQuestionID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingAnswerID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingAnswerName;
@property(nonatomic, copy, readonly, nullable) NSString* pollingAnsweredContent;
@property(nonatomic, assign, readonly) BOOL isChecked;
@end
 
 
@interface ZoomSDKPollingAnswerResultItem : NSObject
@property(nonatomic, copy, readonly, nullable) NSString* pollingID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingQuestionID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingSubQuestionID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingAnswerID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingAnswerName;
@property(nonatomic, assign, readonly) unsigned int selectedCount;
@end
 
 
@interface ZoomSDKPollingQuestionItem : NSObject
@property(nonatomic, copy, readonly, nullable) NSString* pollingID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingQuestionID;
@property(nonatomic, copy, readonly, nullable) NSString* pollingQuestionName;
@property(nonatomic, assign, readonly) ZoomSDKPollingQuestionType pollingQuestionType;
@property(nonatomic, assign, readonly) unsigned int answeredCount;
@property(nonatomic, assign, readonly) BOOL isRequired;
@property(nonatomic, retain, readonly, nullable) NSArray<ZoomSDKPollingQuestionItem*>* pollingSubQuestionItemList;
@property(nonatomic, retain, readonly, nullable) NSArray<ZoomSDKPollingAnswerItem*>* pollingAnswerItemList;
@end
 
 
 
@protocol ZoomSDKPollingControllerDelegate <NSObject>
@optional
- (void)onPollingStatusChanged:(NSString*)pollingID status:(ZoomSDKPollingStatus)status;
 
- (void)onPollingResultUpdated:(NSString*)pollingID;
 
- (void)onPollingListUpdated;
 
- (void)onPollingActionResult:(ZoomSDKPollingActionType)actionType pollingID:(NSString*)pollingID bSuccess:(BOOL)bSuccess errorMsg:(NSString*_Nullable)errorMsg;
 
- (void)onPollingQuestionImageDownloaded:(NSString*)questionID path:(NSString*)path;
 
- (void)onGetPollingElapsedTime:(NSString*)pollingID elapsedTime:(unsigned int)elapsedTime;
 
- (void)onGetRightAnswerListPrivilege:(BOOL)bCan;
 
- (void)onPollingInactive;
@end
 
 
@interface ZoomSDKPollingController : NSObject
{
    id<ZoomSDKPollingControllerDelegate> _delegate;
}
@property(nonatomic, assign, nullable)id<ZoomSDKPollingControllerDelegate> delegate;
 
//Common (for all)
- (BOOL)canDoPolling;
 
- (BOOL)canShowAnswerResultList:(NSString*)pollingID;
 
- (NSArray<ZoomSDKPollingQuestionItem*>*)getPollingQuestionItemList:(NSString*)pollingID;
 
- (NSArray<ZoomSDKPollingAnswerItem*>*)getPollingRightAnswerItemList:(NSString*)pollingID;
 
- (NSArray<ZoomSDKPollingAnswerResultItem*>*)getPollingAnswerResultItemList:(NSString*)pollingID;
 
- (ZoomSDKPollingItem*)getPollingItemByID:(NSString*)pollingID;
 
- (BOOL)canGetRightAnswerItemList:(NSString*)pollingID;
 
- (NSString*)getPollingQuestionImagePath:(NSString*)pollingID questionID:(NSString*)questionID;
 
- (ZoomSDKError)getQuestionCharactersLengthRange:(NSString*)pollingID questionID:(NSString*)questionID minLen:(unsigned int*)minLen maxLen:(unsigned int*)maxLen;
 
- (BOOL)isQuestionCaseSensitive:(NSString*)pollingID questionID:(NSString*)questionID;
 
- (NSString*)getActivePollingID;
 
 
//Host
- (BOOL)canAddPolling;
 
- (ZoomSDKError)addPolling;
 
- (BOOL)canEditPolling:(NSString*)pollingID;
 
- (ZoomSDKError)editPolling:(NSString*)pollingID;
 
- (BOOL)canDeletePolling:(NSString*)pollingID;
 
- (ZoomSDKError)deletePolling:(NSString*)pollingID;
 
- (BOOL)canDuplicatePolling:(NSString*)pollingID;
 
- (ZoomSDKError)duplicatePolling:(NSString*)pollingID;
 
- (BOOL)canViewPollingResultFromBrowser:(NSString*)pollingID;
 
- (ZoomSDKError)viewPollingResultFromBrowser:(NSString*)pollingID;
 
- (NSArray<ZoomSDKPollingItem*>*)getPollingItemList;
 
- (BOOL)canStartPolling:(NSString*)pollingID;
 
- (ZoomSDKError)startPolling:(NSString*)pollingID;
 
- (ZoomSDKError)stopPolling:(NSString*)pollingID;
 
- (BOOL)canRestartPolling:(NSString*)pollingID;
 
- (ZoomSDKError)restartPolling:(NSString*)pollingID;
 
- (BOOL)canSharePollingResult:(NSString*)pollingID;
 
- (ZoomSDKError)startSharePollingResult:(NSString*)pollingID;
 
- (ZoomSDKError)stopSharePollingResult:(NSString*)pollingID;
 
- (ZoomSDKError)enableGetRightAnswerList:(BOOL)bEnable;
 
- (BOOL)canDownloadResult;
 
- (ZoomSDKError)downLoadResult;
 
 
- (ZoomSDKError)setAnswerCheck:(ZoomSDKPollingAnswerItem*)answerItem bCheck:(BOOL)bCheck;
 
- (ZoomSDKError)setAnswerContent:(ZoomSDKPollingAnswerItem*)answerItem answerText:(NSString*)answerText;
 
- (BOOL)canSubmitPolling:(NSString*)pollingID;
 
- (ZoomSDKError)submitPolling:(NSString*)pollingID;
@end
NS_ASSUME_NONNULL_END