开发者在应用FA中通过调用流转任务管理服务、分布式任务调度的接口,实现多端协同。
主要流程如下:
流转任务管理服务提供的注册、解注册、显示设备列表、上报业务状态是实现多端协同的前提。开发者使用分布式服务平台提供的连接和断开连接PA、启动远程FA、启动和关闭PA的能力,可实现自定义的多端协同体验。
接口名 | 描述 |
---|---|
void register(String bundleName, ExtraParams parameter, IContinuationDeviceCallback deviceCallback, RequestCallback requestCallback) | 注册并连接到流转任务管理服务,并获取对应的注册token。 参数说明: bundleName,必填,String类型,本应用包名。params,可选,ExtraParams类型,系统推荐流转时所需的过滤条件。如对智能推荐无特殊要求,可与showDeviceList接口的过滤条件保持一致。若需关闭系统推荐流转,ExtraParams中jsonParams传入{"isTurnOffRecommend":true}即可。deviceCallback,可选,设备选择列表中选择设备后的回调,返回选择设备ID。requestCallback,可选,注册请求回调,返回应用注册后的token。ExtraParams说明: devType,可选,待连接的设备类型。可取值("00E"手机、"011"平板、"06D"手表、"09C"智慧屏),如"devType":["011"]。若为空,则支持则待连接的设备类型为手机、平板、手表和智慧屏。targetBundleName,可选,目标应用包名。若为空,则目标应用包名与方法入参bundleName本应用包名相同。description,可选,ability描述,用于在设备列表页面展示jsonParams,可选,拓展参数。用于设备过滤等。示例: {"filter":{"commonFilter": {"system":{"harmonyVersion":"2.0.0"},"groupType": "1","curComType": 0x00000004, "faFilter":"{\"targetBundleName\":\"com.xxx.yyy\"}"}},"transferScene":0,"isTurnOffRecommend":false,"remoteAuthenticationDescription": "拉起HiVision扫描弹框描述","remoteAuthenticationPicture":""} jsonParams说明: system:可选,String类型,待连接设备的HarmonyOS版本号,目标设备对应的harmonyVersion>=该值,如"system":{"harmonyVersion":"2.0.0"}。groupType:可选,String类型。为空时,不要求是否同帐号。本设备和待连接设备的帐号是否要求一致,可取值(1要求同帐号、1|256不要求同帐号),如"groupType":"1"。curComType:可选,int类型。为空时,不要求在同一局域网下。本设备和待连接设备是否需要在同一局域网下,可取值(0x00000004需要在同一局域网下,0x00030004不需要在同一局域网下),如"curComType":0x00000004。faFilter:可选,String类型,目标应用包名。为空时,不做版本兼容性检查。要做版本兼容性检查时,需要传入目标应用包名。使用faFilter,设备需登录帐号。多端设备可使用不同帐号,但不支持无账号使用faFilter。transferScene:可选,int类型,默认值为0。可取值为:0-单选协同场景,设备选择面板为单选面板,设备间互斥,流转成功设备面板自动消失,流转失败设备面板不消失,且系统会维护设备的流转状态,如流转成功设备面板消失后再打开设备面板,会显示之前设备流转成功的状态;1-单选迁移场景,设备选择面板为单选面板,设备间互斥,流转成功设备面板自动消失,流转失败设备面板不消失,且系统不会维护设备的流转状态,如流转成功设备面板消失后再打开设备面板,设备流转状态为未流转;2-多选协同场景,设备选择面板为多选面板,流转成功或失败设备面板不消失,设备间不互斥,系统会维护设备的流转状态。isTurnOffRecommend:可选,boolean类型,默认为false,true:关闭系统推荐流转,false:开启系统推荐流转。remoteAuthenticationDescription:可选,String类型,跨账号/无账号设备进行扫码认证时,拉起对端HiVision扫描弹框描述。register接口无需传该参数,showDeviceList可按需传参。remoteAuthenticationPicture:可选,String类型,跨账号/无账号设备进行扫码认证时,拉起对端HiVision扫描弹框显示的图片。需将图片对应的byte[]转String, Base64.encodeToString(mBuff,Base64.DEFAULT)。register接口无需传该参数,showDeviceList可按需传参。注册后,通过RequestCallback的onResult回调知道执行是否成功,返回值为<0时为失败;其他情况,表示成功,并返回本次流转任务的唯一标识token。 当用户选择设备后,通过deviceCallback定义的onConnected回调获取设备的deviceID、类型、名称。 |
void unregister(int token, RequestCallback requestCallback) | 从流转任务管理服务解注册,传入注册时获取的token进行解注册。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 |
void updateConnectStatus(int token, String deviceId, int status, RequestCallback requestCallback) | 通知流转任务管理服务更新当前用户程序的连接状态,并在流转任务管理服务界面展示给用户。token、deviceId参数来自于注册流转任务管理服务的回调。status参数可以为IDLE、CONNECTING、CONNECTED、DIS_CONNECTING。如果有错误,需要上报errorCode。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 |
void showDeviceList(int token, ExtraParams parameter, RequestCallback requestCallback) | 显示组网内可选择设备列表信息。该接口提供手动显示设备列表的能力,parameter参数可以指定设备过滤的条件,用于手动多端协同,支持的过滤条件与register接口相同。token参数来自于注册流转任务管理服务的回调。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 |
void disconnect() | 在应用退出时,主动调用断开和流转任务管理服务的连接。 |
ExtraParams说明:
jsonParams说明:
注册后,通过RequestCallback的onResult回调知道执行是否成功,返回值为<0时为失败;其他情况,表示成功,并返回本次流转任务的唯一标识token。 当用户选择设备后,通过deviceCallback定义的onConnected回调获取设备的deviceID、类型、名称。 void unregister(int token, RequestCallback requestCallback) 从流转任务管理服务解注册,传入注册时获取的token进行解注册。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 void updateConnectStatus(int token, String deviceId, int status, RequestCallback requestCallback) 通知流转任务管理服务更新当前用户程序的连接状态,并在流转任务管理服务界面展示给用户。token、deviceId参数来自于注册流转任务管理服务的回调。status参数可以为IDLE、CONNECTING、CONNECTED、DIS_CONNECTING。如果有错误,需要上报errorCode。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 void showDeviceList(int token, ExtraParams parameter, RequestCallback requestCallback) 显示组网内可选择设备列表信息。该接口提供手动显示设备列表的能力,parameter参数可以指定设备过滤的条件,用于手动多端协同,支持的过滤条件与register接口相同。token参数来自于注册流转任务管理服务的回调。 执行后,通过RequestCallback的onResult回调知道执行是否成功。 void disconnect() 在应用退出时,主动调用断开和流转任务管理服务的连接。
接口名 | 描述 |
---|---|
void onConnected(ContinuationDeviceInfo deviceInfo) | 当用户从选择设备列表选择设备时调用,返回设备ID、设备类型和设备名称供开发者使用。 |
void onDisconnected(String deviceId) | 当流转任务管理服务断开连接设备时调用。 |
接口名 | 描述 |
---|---|
void onResult(int result) | 与流转任务管理服务交互成功时调用。当作为注册流转任务管理服务的回调对象时,注册成功后给用户程序返回对应的token。 |
接口名 | 描述 |
---|---|
IContinuationRegisterManager getContinuationRegisterManager() | 获取流转任务管理服务注册服务管理类,可以与流转任务管理服务进行交互,包括注册/解注册,更新设备连接状态,显示可选择设备列表等。 |
void startAbility(Intent intent) | 提供启动指定设备上FA和PA的能力,Intent中指定待启动FA/PA的设备deviceId、bundleName和abilityName。若不指定设备deviceId,则无法跨设备调用PA。类似地,在启动FA时,也需要开发者指定启动FA的设备deviceId、bundleName和abilityName。 分布式服务平台还会提供与上述功能相对应的断开远程PA的连接和关闭远程PA的接口,相关的参数与连接、启动的接口类似。 |
boolean connectAbility(Intent intent, IAbilityConnection conn) | 提供连接指定设备上PA的能力,Intent中指定待连接PA的设备deviceId、bundleName和abilityName。当连接成功后,通过在conn定义的onAbilityConnectDone回调中获取对端PA的服务代理,两者的连接关系则由conn维护。 |
boolean stopAbility(Intent intent) | 提供关闭远程PA的能力,Intent中指定待关闭PA的设备deviceId、bundleName和abilityName。 |
void terminateAbility() | 提供关闭当前FA/PA的能力,调用该接口将开始销毁调用的FA/PA。 |
void disconnectAbility(IAbilityConnection conn) | 提供断开远程PA连接能力,conn需要指定为connectAbility连接指定设备上PA时,传入的IAbilityConnection对象。 |
接口名 | 描述 |
---|---|
void onAbilityConnectDone(ElementName element, IRemoteObject remote, int resultCode) | 当连接Service服务成功时调用,可使用返回的IRemoteObject对象与连接的Service服务通信。 |
void onAbilityDisconnectDone(ElementName element, int resultCode) | 当已连接的Service服务被异常关闭时调用。 |
接口名 | 描述 |
---|---|
void initDistributedEnvironment(String deviceId, IInitCallBack callback) | 初始化分布式服务平台。其中deviceId指明设备Id;callback指明初始化分布式环境状态回调,参考IInitCallBack接口描述。 |
void unInitDistributedEnvironment(String deviceId, IInitCallBack callback) | 不再使用分布式服务平台。 |
接口名 | 描述 |
---|---|
void onInitSuccess(String deviceId) | 成功回调。 |
void onInitFailure(String deviceId, int errorCode) | 失败回调。 |