BBASMBrightnessPlugin.h 2.62 KB
//
//  BBASMBrightnessPlugin.h
//  SWAN
//
//  Created by baidu on 2018/5/8.
//  Copyright © 2018年 baidu. All rights reserved.
//

#import "BBASMUtilities.h"

@interface BBASMBrightnessPlugin : BBASDPluginBase

/**
 * 描  述: 小程序屏幕亮度设置
 * 示  例: baiduboxapp://swanAPI/brightness/set?params=%7B%22value%22%3A%220.5%22%7D&callback=_bdbox_js_468&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_brightness_set
 * 备  注:
 * ********** description ************
 * @name:      setScreenBrightness
 * @authority: swanAPI
 * @path:      /brightness/set
 * @args:      [{"name": "value", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)set:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 获取屏幕亮度
 * 示  例: baiduboxapp://swanAPI/brightness/get?callback=_bdbox_js_1015&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_brightness_get
 * 备  注:
 * ********** description ************
 * @name:      getScreenBrightness
 * @authority: swanAPI
 * @path:      /brightness/get
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.deviceBridge.getScreenBrightness"}}}
 */
- (void)get:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 设置是否保持常亮状态
 * 示  例: baiduboxapp://swanAPI/brightness/keepScreenOn?params={"keepScreenOn":true}&callback=_bdbox_js_1017&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_brightness_keepscreenon
 * 备  注:
 * ********** description ************
 * @name:      setKeepScreenOn
 * @authority: swanAPI
 * @path:      /brightness/keepScreenOn
 * @args:      [{"name": "keepScreenOn", "value": "boolean"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.deviceBridge.setKeepScreenOn"}}}
 */
- (void)keepScreenOn:(BBASchemeDispatcher *)dispatcher;

#pragma mark - not API

/**
 * @brief 获取屏幕亮度
 * @param action 端能力名称
 * @return 调用结果
 */
+ (NSDictionary *)getScreenBrightnessWithActionName:(NSString *)action;

/**
 * @brief 设置是否保持常亮状态
 * @param appId 小程序appId
 * @param params 端能力参数
 * @param action 端能力名称
 * @return 调用结果
 */
+ (NSDictionary *)setKeepScreenOnWithAppId:(NSString *)appId
                                    params:(NSDictionary *)params
                                actionName:(NSString *)action;
@end