ZoomCCInterface.h

//
//  ZoomCCInterface.h
//  ZoomCCSDK
//
 
#import <UIKit/UIKit.h>
 
NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSInteger, ZoomCCIInterfaceType) {
    ZoomCCIInterfaceType_Unknown,
    ZoomCCIInterfaceType_Chat,
    ZoomCCIInterfaceType_Video,
    ZoomCCIInterfaceType_ZVA,
    ZoomCCIInterfaceType_ScheduledCallback,
};
 
typedef NS_ENUM(NSInteger, ZoomCCVideoPreviewOption) {
    ZoomCCVideoPreviewOption_default,
    ZoomCCVideoPreviewOption_noPreviewWithCameraOn,
    ZoomCCVideoPreviewOption_noPreviewWithCameraOff
};

typedef NS_ENUM(NSInteger, ZoomCCSDKStatus) {
    ZoomCCSDKStatus_Initial,
    ZoomCCSDKStatus_Connecting,
    ZoomCCSDKStatus_Login,
    ZoomCCSDKStatus_Disconnect
};

typedef NS_ENUM(NSInteger, ZoomCCSDKEvent) {
    ZoomCCSDKEvent_VideoTaskCreated,
    ZoomCCSDKEvent_VideoJoinButtonClicked,
    ZoomCCSDKEvent_VideoStart,
    ZoomCCSDKEvent_VideoLeaveButtonClicked,
    ZoomCCSDKEvent_VideoEndedForcefully,
    ZoomCCSDKEvent_VideoEnd,
};

typedef NS_ENUM(NSInteger, ZoomCCSDKDomainType) {
    ZoomCCSDKDomainType_None = 0,
    ZoomCCSDKDomainType_US01,
    ZoomCCSDKDomainType_EU01,
    ZoomCCSDKDomainType_SA01,
    ZoomCCSDKDomainType_US08,
    ZoomCCSDKDomainType_UK01,
};

typedef void (^ZoomCCFetchUIBlock)(UIViewController * _Nullable viewController);

@interface ZoomCCContext : NSObject
@property(nonatomic, copy) NSString *userName;
@property(nonatomic, assign) BOOL enableLog;
@property(nullable, nonatomic, copy) NSString *cacheFolder;
@property(nullable, nonatomic, copy) NSString *deviceShareBundleID;
@property(nullable, nonatomic, copy) NSString *appGroupID;
@property(nonatomic, assign) ZoomCCSDKDomainType domainType;
@end
 
 
 
@interface ZoomCCCampaignInfo: NSObject
// In a campaign, there could be several channels like chat channel and
// video channel. The value can be ZoomCCIInterfaceType_Chat,
// ZoomCCIInterfaceType_Video and ZoomCCIInterfaceType_ZVA,
// ZoomCCIInterfaceType_Chat, or ZoomCCIInterfaceType_ScheduledCallback.
@property(nonatomic, copy) NSArray <NSNumber *> *translatedCampaignChannels;
@property(nonatomic, copy) NSString *campaignId;
@property(nonatomic, copy) NSString *campaignLanguage;
@property(nonatomic, copy) NSString *campaignName;
@end

@interface ZoomCCItem: NSObject
@property(nonatomic, copy) NSString *entryId;

@property(nonatomic, copy) NSString *apiKey;
@property(nonatomic, assign) ZoomCCIInterfaceType sdkType;
 

@property(nonatomic, assign) BOOL useCampaignMode;

@property(nonatomic, strong, nullable) ZoomCCCampaignInfo *campaignInfo;

@property(nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *engagementVariables;
@end
 
@protocol ZoomCCChatService, ZoomCCVideoService;
@protocol ZoomCCService;

@protocol ZoomCCServiceDelegate <NSObject>
@optional
- (void)onService:(id<ZoomCCService>)service error:(NSUInteger)error detail:(NSInteger)detail  __attribute__((deprecated("This method is deprecated. Use onService:error:detail:description: to replace this")));

- (void)onService:(id<ZoomCCService>)service error:(NSUInteger)error detail:(NSInteger)detail description:(NSString *_Nullable)description;

- (void)onService:(id<ZoomCCService>)service engagementStart:(NSString*)engagementId;

- (void)onService:(id<ZoomCCService>)service engagementEnd:(NSString*)engagementId;

- (void)onService:(id<ZoomCCService>)service eventChange:(ZoomCCSDKEvent)event;

- (void)onService:(id<ZoomCCService>)service
engagementVariablesRequired:(NSArray<NSDictionary<NSString *, NSString *> *> *)variables;

- (void)onService:(id<ZoomCCService>)service loginStatusChanged:(ZoomCCSDKStatus)status;
@end

@protocol ZoomCCService <NSObject>
@property(nonatomic, readonly) ZoomCCItem *item;

@property(nonatomic, assign, readonly) ZoomCCSDKStatus status;

@property(nonatomic, assign, readonly) BOOL inEngagement;

@property(nullable, nonatomic, copy, readonly) NSString *engagementId;

- (void)initializeWithItem:(ZoomCCItem *)item;

- (void)uninitialize;
- (BOOL)login;
- (BOOL)logout;

- (void)fetchUI:(ZoomCCFetchUIBlock)complete;
@end

@protocol ZoomCCChatServiceDelegate <ZoomCCServiceDelegate>
@optional
- (void)onChatService:(id<ZoomCCChatService>)service unreadMsgCountChanged:(NSUInteger)count;
@end
 
@protocol ZoomCCChatService <ZoomCCService>
@property(nullable, nonatomic, weak) id<ZoomCCChatServiceDelegate> chatDelegate;
@property(nonatomic, assign, readonly) NSUInteger unreadMsgCount;

- (void)endChat;
@end

@protocol ZoomCCVideoService <ZoomCCService>

@property(nonatomic, assign) ZoomCCVideoPreviewOption videoPreviewOptions;

@property(nonatomic, assign) BOOL autoJoinWhenVideoCreated;

@property(nullable, nonatomic, weak) id<ZoomCCServiceDelegate> videoDelegate;

- (void)endVideo;

- (BOOL)handleRejoinVideoOpenURL:(NSURL *)rejoinURL item:(ZoomCCItem *)item videoDelegate:(id<ZoomCCServiceDelegate>)videoDelegate complete:(void(^)(UIViewController * _Nonnull viewController))complete;

- (BOOL)handleShortLinkVideoURL:(NSURL *)url item:(ZoomCCItem *)item videoDelegate:(id<ZoomCCServiceDelegate>)videoDelegate complete:(void(^)(UIViewController * _Nonnull viewController))complete;
 
@end
 
@protocol ZoomCCScheduledCallbackService <ZoomCCService>

@property (nonatomic, weak) id<ZoomCCServiceDelegate> scheduledCallbackDelegate;

- (void)endScheduledCallback;
@end

@protocol ZoomCCAppLifecyleDelegate <NSObject>
- (void)appWillResignActive;

- (void)appDidBecomeActive;

- (void)appDidEnterBackgroud;

- (void)appWillTerminate;
@end

@interface ZoomCCInterface : NSObject <ZoomCCAppLifecyleDelegate>

+ (ZoomCCInterface *)sharedInstance;

@property(nonatomic, strong) ZoomCCContext *context;

- (id<ZoomCCChatService>)chatService;

- (id<ZoomCCChatService>)zvaService;

- (id<ZoomCCVideoService>)videoService;

- (id<ZoomCCScheduledCallbackService>)scheduledCallbackService;

- (NSString *)sdkVersion;
 

- (void)getCampaigns:(NSString *)apiKey complete:(void(^)(bool success, NSArray <ZoomCCCampaignInfo *>* campaigns))complete;
@end
 
NS_ASSUME_NONNULL_END