Ability Context

说明： 本模块首批接口从API version 9开始支持。API 9当前为Canary版本，仅供使用，不保证接口可稳定调用。

Ability的上下文环境，继承自Context。

导入模块

import Ability from '@ohos.application.Ability'

使用说明

在使用AbilityContext的功能前，需要通过Ability子类实例获取。

import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
        let context = this.context;
    }
}

属性

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

startAbility

startAbility(want: Want, callback: AsyncCallback<void>): void

启动Ability。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
this.context.startAbility(want, (error) => {
    console.log("error.code = " + error.code)
})

startAbility

startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void

启动Ability（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
var options = {
  windowMode: 0,
};
this.context.startAbility(want, options, (error) => {
    console.log("error.code = " + error.code)
})

startAbility

startAbility(want: Want, options: StartOptions): Promise<void>

启动Ability（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
var options = {
  windowMode: 0,
};
this.context.startAbility(want, options)
.then((data) => {
    console.log('Operation successful.')
}).catch((error) => {
    console.log('Operation failed.');
})

startAbilityByCall

startAbilityByCall(want: Want): Promise<Caller>

获取指定通用组件服务端的caller通信接口, 并且将指定通用组件服务端拉起并切换到后台。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
        this.context.startAbilityByCall({
            bundleName: "com.example.myservice",
            abilityName: "com.example.myservice.MainAbility",
            deviceId: ""
        }).then((obj) => {
            caller = obj;
            console.log('Caller GetCaller Get ' + call);
        }).catch((e) => {
            console.log('Caller GetCaller error ' + e);
        });
    }
}

startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void

通过账户启动Ability（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
var accountId = 11;
this.context.startAbility(want, accountId, (error) => {
    console.log("error.code = " + error.code)
})

startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void

通过账户启动Ability（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
var options = {
  windowMode: 0,
};
var accountId = 11;
this.context.startAbility(want, accountId, options, (error) => {
    console.log("error.code = " + error.code)
})

startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<void>

通过账户启动Ability（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
};
var options = {
  windowMode: 0,
};
var accountId = 11;
this.context.startAbility(want, accountId, options)
.then((data) => {
    console.log('Operation successful.')
}).catch((error) => {
    console.log('Operation failed.');
})

startAbilityForResult

startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void

启动Ability并在结束的时候返回执行结果（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

this.context.startAbilityForResult(
    {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"},
    (error, result) => {
      console.log("startAbilityForResult AsyncCallback is called, error.code = " + error.code)
      console.log("startAbilityForResult AsyncCallback is called, result.resultCode = " + result.resultCode)
    }
);

startAbilityForResult

startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void

启动Ability并在结束的时候返回执行结果（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var options = {
  windowMode: 0,
};
this.context.startAbilityForResult(
    {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}, options,
    (error, result) => {
      console.log("startAbilityForResult AsyncCallback is called, error.code = " + error.code)
      console.log("startAbilityForResult AsyncCallback is called, result.resultCode = " + result.resultCode)
    }
);

startAbilityForResult

startAbilityForResult(want: Want, options: StartOptions): Promise<AbilityResult>;

启动Ability并在结束的时候返回执行结果（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

var options = {
  windowMode: 0,
};
this.context.startAbilityForResult({bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}, options).then((result) => {
    console.log("startAbilityForResult Promise.resolve is called, result.resultCode = " + result.resultCode)
}, (error) => {
    console.log("startAbilityForResult Promise.Reject is called, error.code = " + error.code)
})

startAbilityForResultWithAccount

startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>): void

通过账户启动Ability并在结束的时候返回执行结果（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var accountId = 111;
this.context.startAbilityForResult(
    {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"},
    accountId, 
    (error, result) => {
      console.log("startAbilityForResult AsyncCallback is called, error.code = " + error.code)
      console.log("startAbilityForResult AsyncCallback is called, result.resultCode = " + result.resultCode)
    }
);

startAbilityForResultWithAccount

startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void

通过账户启动Ability并在结束的时候返回执行结果（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var options = {
  windowMode: 0,
};
var accountId = 111;
this.context.startAbilityForResult(
    {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}, 
    accountId, 
    options,
    () => {
      console.log("startAbilityForResult AsyncCallback is called")
    }
);

startAbilityForResultWithAccount

startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<AbilityResult>;

通过账户启动Ability并在结束的时候返回执行结果（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

var accountId = 111;
var options = {
  windowMode: 0,
};
this.context.startAbilityForResult({bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}, accountId, options).then((result) => {
    console.log("startAbilityForResult Promise.resolve is called, result.resultCode = " + result.resultCode)
}, (error) => {
    console.log("startAbilityForResult Promise.Reject is called, error.code = " + error.code)
})

terminateSelf

terminateSelf(callback: AsyncCallback<void>): void

停止Ability自身（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

this.context.terminateSelf((err) => {
    console.log('terminateSelf result:' + JSON.stringify(err));
});

terminateSelf

terminateSelf(): Promise<void>

停止Ability自身（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

示例：

this.context.terminateSelf(want).then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

terminateSelfWithResult

terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void

停止Ability，并返回给调用startAbilityForResult 接口调用方的相关信息（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

this.context.terminateSelfWithResult(
    {
        want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"},
        resultCode: 100
    }, (error) => {
        console.log("terminateSelfWithResult is called = " + error.code)
    }
);

terminateSelfWithResult

terminateSelfWithResult(parameter: AbilityResult): Promise<void>

停止Ability，并返回给调用startAbilityForResult 接口相关信息（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

this.context.terminateSelfWithResult(
{
    want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"},
    resultCode: 100
}).then((result) => {
    console.log("terminateSelfWithResult")
})

connectAbility

connectAbility(want: Want, options: ConnectOptions): number

使用AbilityInfo.AbilityType.SERVICE模板将当前能力连接到一个能力。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值:

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
}
var options = {
  onConnect: (elementName, remote) => {
    console.log('connectAbility onConnect, elementName: ' + elementName + ', remote: ' + remote)
  },
  onDisconnect: (elementName) => {
    console.log('connectAbility onDisconnect, elementName: ' + elementName)
  },
  onFailed: (code) => {
    console.log('connectAbility onFailed, code: ' + code)
  }
}
let result = this.context.connectAbility(want, options) {
  console.log('code: ' + result)
}

connectAbilityWithAccount

connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number

使用AbilityInfo.AbilityType.SERVICE模板和账户ID将当前能力连接到一个能力。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值:

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "com.extreme.test.MainAbility"
}
var accountId = 111;
var options = {
  onConnect: (elementName, remote) => {
    console.log('connectAbility onConnect, elementName: ' + elementName + ', remote: ' + remote)
  },
  onDisconnect: (elementName) => {
    console.log('connectAbility onDisconnect, elementName: ' + elementName)
  },
  onFailed: (code) => {
    console.log('connectAbility onFailed, code: ' + code)
  }
}
this.context.connectAbility(want, accountId, options) {
  console.log('code: ' + code)
}

disconnectAbility

disconnectAbility(connection: number, callback:AsyncCallback<void>): void

断开Ability连接（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var connection = 111;
this.context.disconnectAbility(connection, () => {
  console.log('disconnection')
})

disconnectAbility

disconnectAbility(connection: number): Promise<void>

断开Ability连接（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

var connection = 111;
this.context.disconnectAbility(connection).then(() => {
  console.log('disconnect success')
}).catch((err) => {
  console.log('disconnect failed')
})

setMissionLabel

setMissionLabel(label: string, callback:AsyncCallback<void>): void

设置ability在任务中显示的名称（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

this.context.setMissionLabel("test",(result) => {
    console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
});

setMissionLabel

setMissionLabel(label: string): Promise<void>

设置ability在任务中显示的名称（Promise形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

this.context.setMissionLabel("test").then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

requestPermissionsFromUser

requestPermissionsFromUser(permissions: Array<string>, requestCallback: AsyncCallback<PermissionRequestResult>) : void

拉起弹窗请求用户授权（callback形式）。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

this.context.requestPermissionsFromUser(permissions,(result) => {
    console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
});

requestPermissionsFromUser

requestPermissionsFromUser(permissions: Array<string>) : Promise<PermissionRequestResult>

拉起弹窗请求用户授权。通过Promise返回结果。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

返回值：

示例：

this.context.requestPermissionsFromUser(permissions).then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

restoreWindowStage

restoreWindowStage(contentStorage: ContentStorage) : void

恢复Ability延续中的窗口阶段数据。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

示例：

var contentStorage = {
  "link": 'link',
};
this.context.restoreWindowStage(contentStorage);