View on GitHub
PLVLiveVClassAPI Class Reference
PLVLiveVClassAPI
Objective-C
@interface PLVLiveVClassAPI : NSObject
/// 讲师登录接口返回的token，登出时置nil
/// @note 一般在内部进行配置，仅当讲师端缓存有Token时会在外部直接设置
@property (class, nonatomic, strong) NSString * _Nullable teachToken;
/// 学生登录接口返回的token，登出时置nil
/// @note 仅在内部进行配置
@property (class, nonatomic, strong, readonly) NSString * _Nullable watchToken;
/// 获取课程或课节简单信息
/// @param courseCode 课程号
/// @param lessonId 课节ID
/// @param successHandler 登录成功时，触发该block
/// @param failureHandler 登录失败时，触发该block
+ (void)courseOrLessonSimpleInfoWithCourseCode:(NSString * _Nullable)courseCode
lessonId:(NSString * _Nullable)lessonId
success:(void (^)(NSDictionary *responseDict))successHandler
failure:(void (^ _Nullable)(NSError *error))failureHandler;
/// 获取课节结束信息
/// @param lessonId 课节ID
/// @param isTeach 是否是讲师端获取
/// @param successHandler 登录成功时，触发该block
/// @param failureHandler 登录失败时，触发该block
+ (void)lessonFinishInfoWithLessonId:(NSString *)lessonId
isTeach:(BOOL)isTeach
success:(void (^)(NSDictionary *responseDict))successHandler
failure:(void (^ _Nullable)(NSError *error))failureHandler;
@endSwift
class PLVLiveVClassAPI : NSObjectUndocumented
-
讲师登录接口返回的token，登出时置nil
Note
一般在内部进行配置，仅当讲师端缓存有Token时会在外部直接设置Declaration
Objective-C
@property (class, nonatomic, strong) NSString *_Nullable teachToken;Swift
class var teachToken: String? { get set } -
学生登录接口返回的token，登出时置nil
Note
仅在内部进行配置Declaration
Objective-C
@property (class, nonatomic, strong, readonly) NSString *_Nullable watchToken;Swift
class var watchToken: String? { get } -
获取课程或课节简单信息
Declaration
Objective-C
+ (void)courseOrLessonSimpleInfoWithCourseCode:(NSString *_Nullable)courseCode lessonId:(NSString *_Nullable)lessonId success:(nonnull void (^)( NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)( NSError *_Nonnull)) failureHandler;Swift
class func courseOrLessonSimpleInfo(withCourseCode courseCode: String?, lessonId: String?, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
successHandler登录成功时，触发该block
failureHandler登录失败时，触发该block
-
获取课节结束信息
Declaration
Objective-C
+ (void)lessonFinishInfoWithLessonId:(nonnull NSString *)lessonId isTeach:(BOOL)isTeach success:(nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func lessonFinishInfo(withLessonId lessonId: String, isTeach: Bool, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
isTeach是否是讲师端获取
successHandler登录成功时，触发该block
failureHandler登录失败时，触发该block
-
讲师登录接口
Declaration
Objective-C
+ (void)teacherLoginWithMobile:(nonnull NSString *)mobile password:(nonnull NSString *)password code:(NSString *_Nullable)code userId:(NSString *_Nullable)userId mutipleCompany: (nonnull void (^)(NSArray *_Nonnull))mutipleCompanyHandler success:(nonnull void (^)(NSDictionary *_Nonnull, NSArray *_Nonnull))success failure:(void (^_Nullable)(NSError *_Nonnull))failure;Swift
class func teacherLogin(withMobile mobile: String, password: String, code: String?, userId: String?, mutipleCompany mutipleCompanyHandler: @escaping ([Any]) -> Void, success: @escaping ([AnyHashable : Any], [Any]) -> Void, failure: ((Error) -> Void)? = nil)Parameters
mobile讲师11位手机号
password讲师密码
code区号，可为空，默认+86
userId机构Id，可为空，讲师重复时不可为空
mutipleCompanyHandler讲师重复时，触发该block，返回讲师所属机构列表
success登录成功时，触发该block
failure登录失败时，触发该block
-
校验当前进入该课节的老师是否被顶出去
Declaration
Objective-C
+ (void)teacherReloginVerifyWithLessonId:(nonnull NSString *)lessonId relogin:(nonnull void (^)(NSString *_Nonnull)) reloginHandler success: (void (^_Nullable)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherReloginVerify(withLessonId lessonId: String, relogin reloginHandler: @escaping (String) -> Void, success successHandler: (([AnyHashable : Any]) -> Void)?, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
reloginHandler确认老师被顶出去时，触发该block
successHandler接口调用成功时，触发该block
failureHandler接口调用失败时，触发该block
-
讲师获取课节列表接口
Declaration
Objective-C
+ (void)teacherLessonListWithUserId:(NSString *_Nullable)userId success:(nonnull void (^)(NSArray *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherLessonList(withUserId userId: String?, success successHandler: @escaping ([Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
userId机构Id，可为空
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师获取课节状态接口
Declaration
Objective-C
+ (void)teacherLessonStatusWithLessonId:(nonnull NSString *)lessonId success: (nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherLessonStatus(withLessonId lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师获取课节详情接口
Declaration
Objective-C
+ (void)teacherLessonDetailWithLessonId:(nonnull NSString *)lessonId success: (nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherLessonDetail(withLessonId lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师修改课节状态
Declaration
Objective-C
+ (void)teacherChangeLessonStatusWithLessonId:(nonnull NSString *)lessonId status:(NSInteger)status success:(nonnull void (^)(id _Nonnull)) successHandler failure: (void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherChangeLessonStatus(withLessonId lessonId: String, status: Int, success successHandler: @escaping (Any) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
status课节状态（0：未开课，1：上课中，2：已下课）
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师端获取聊天室token
Declaration
Objective-C
+ (void)teacherChatTokenWithLessonId:(nonnull NSString *)lessonId success:(nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherChatToken(withLessonId lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师端获取直播api接口频道级别token
Declaration
Objective-C
+ (void)teacherGetLiveAPIChannelTokenWithLessonId:(nonnull NSString *)lessonId success:(nonnull void (^)( NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)( NSError *_Nonnull)) failureHandler;Swift
class func teacherGetLiveChannelToken(withLessonId lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
Deprecated
Please use ‘teacherGetLiveAPIChannelTokenWithLessonId:success:failure:’ instead
讲师端获取文档token
Declaration
Objective-C
+ (void)teacherDocumentTokenWithLessonId:(nonnull NSString *)lessonId success: (nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func teacherDocumentToken(withLessonId lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
讲师端登出
Declaration
Objective-C
+ (void)teacherLogout;Swift
class func teacherLogout()
-
无条件观看接口，课程号与课节ID必须一个不为空
Declaration
Objective-C
+ (void)watcherVerifyNoneWithCourseCode:(NSString *_Nullable)courseCode lessonId:(NSString *_Nullable)lessonId name:(nonnull NSString *)name success:(nonnull void (^)( NSDictionary *_Nonnull, NSArray *_Nonnull))successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherVerifyNone(withCourseCode courseCode: String?, lessonId: String?, name: String, success successHandler: @escaping ([AnyHashable : Any], [Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
name昵称
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
验证码观看接口，课程号与课节ID必须一个不为空
Declaration
Objective-C
+ (void)watcherVerifyCodeWithCourseCode:(NSString *_Nullable)courseCode lessonId:(NSString *_Nullable)lessonId name:(nonnull NSString *)name code:(nonnull NSString *)code success:(nonnull void (^)( NSDictionary *_Nonnull, NSArray *_Nonnull))successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherVerifyCode(withCourseCode courseCode: String?, lessonId: String?, name: String, code: String, success successHandler: @escaping ([AnyHashable : Any], [Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
name昵称
code验证码
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
白名单观看接口，课程号与课节ID必须一个不为空
Declaration
Objective-C
+ (void) watcherVerifyWhiteListWithCourseCode:(NSString *_Nullable)courseCode lessonId:(NSString *_Nullable)lessonId studentCode:(nonnull NSString *)studentCode success:(nonnull void (^)( NSDictionary *_Nonnull, NSArray *_Nonnull))successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherVerifyWhiteList(withCourseCode courseCode: String?, lessonId: String?, studentCode: String, success successHandler: @escaping ([AnyHashable : Any], [Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
studentCode学生码
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
观看端获取课节列表接口，课程号与课节ID必须一个不为空
Declaration
Objective-C
+ (void)watcherLessonListWithCourseCode:(NSString *_Nullable)courseCode lessonId:(NSString *_Nullable)lessonId success:(nonnull void (^)(NSArray *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherLessonList(withCourseCode courseCode: String?, lessonId: String?, success successHandler: @escaping ([Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
观看端获取课程/课节详情接口
Declaration
Objective-C
+ (void)watcherLessonDetailWithCourseCode:(NSString *_Nullable)courseCode lessonId:(nonnull NSString *)lessonId success: (nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherLessonDetail(withCourseCode courseCode: String?, lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
观看端获取聊天室token
Declaration
Objective-C
+ (void)watcherChatTokenWithCourseCode:(NSString *_Nullable)courseCode lessonId:(nonnull NSString *)lessonId success: (nonnull void (^)(NSDictionary *_Nonnull)) successHandler failure:(void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherChatToken(withCourseCode courseCode: String?, lessonId: String, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
courseCode课程号
lessonId课节ID
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
观看端获取直播api接口频道级别token
Declaration
Objective-C
+ (void) watcherGetLiveAPIChannelTokenWithLessonId:(nonnull NSString *)lessonId courseCode:(NSString *_Nullable)courseCode success:(nonnull void (^)( NSDictionary *_Nonnull)) successHandler failure: (void (^_Nullable)(NSError *_Nonnull)) failureHandler;Swift
class func watcherGetLiveChannelToken(withLessonId lessonId: String, courseCode: String?, success successHandler: @escaping ([AnyHashable : Any]) -> Void, failure failureHandler: ((Error) -> Void)? = nil)Parameters
lessonId课节ID
courseCode课程号
successHandler调用成功时，触发该block
failureHandler调用失败时，触发该block
-
观看端登出
Declaration
Objective-C
+ (void)watcherLogout;Swift
class func watcherLogout()