UIAbilityContext

UIAbilityContext是UIAbility的上下文环境，继承自Context。

UIAbilityContext模块提供允许访问特定UIAbility的资源的能力，包括对UIAbility的启动、停止的设置、获取caller通信接口、拉起弹窗请求用户授权等。

说明：

• 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块接口仅可在Stage模型下使用。

导入模块

import common from '@ohos.app.ability.common';

属性

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

UIAbilityContext.startAbility

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

启动Ability（callback形式）。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  bundleName: 'com.example.myapp',
  abilityName: 'MyAbility'
};

try {
  this.context.startAbility(want, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbility succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbility

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

启动Ability（callback形式）。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let options = {
  windowMode: 0
};

try {
  this.context.startAbility(want, options, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbility succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbility

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

启动Ability（promise形式）。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  bundleName: 'com.example.myapp',
  abilityName: 'MyAbility'
};
let options = {
	windowMode: 0,
};

try {
  this.context.startAbility(want, options)
    .then((data) => {
      // 执行正常业务
      console.log('startAbility succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityForResult

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

启动一个Ability。Ability被启动后，有如下情况(callback形式):

• 正常情况下可通过调用terminateSelfWithResult接口使之终止并且返回结果给调用方。
• 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
• 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability，当这个Ability调用terminateSelfWithResult接口使之终止时，只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};

try {
  this.context.startAbilityForResult(want, (error, result) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbilityForResult succeed, result.resultCode = ' +
      result.resultCode)
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityForResult

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

启动一个Ability。Ability被启动后，有如下情况(callback形式):

• 正常情况下可通过调用terminateSelfWithResult接口使之终止并且返回结果给调用方。
• 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
• 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability，当这个Ability调用terminateSelfWithResult接口使之终止时，只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let options = {
  windowMode: 0,
};

try {
this.context.startAbilityForResult(want, options, (err, result) => {
  if (err.code) {
    // 处理业务逻辑错误
    console.error(`startAbilityForResult failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  // 执行正常业务
  console.info('startAbilityForResult succeed');
});
} catch (err) {
// 处理入参错误异常
console.error(`startAbilityForResult failed, code is ${err.code}, message is ${err.message}`);
}

UIAbilityContext.startAbilityForResult

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

启动一个Ability。Ability被启动后，有如下情况(promise形式):

• 正常情况下可通过调用terminateSelfWithResult接口使之终止并且返回结果给调用方。
• 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
• 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability，当这个Ability调用terminateSelfWithResult接口使之终止时，只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  bundleName: 'com.example.myapp',
  abilityName: 'MyAbility'
};
let options = {
	windowMode: 0,
};

try {
  this.context.startAbilityForResult(want, options)
    .then((result) => {
      // 执行正常业务
      console.log('startAbilityForResult succeed, result.resultCode = ' + result.resultCode);
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityForResultWithAccount

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

启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbilityForResultWithAccount succeed, result.resultCode = ' +
      result.resultCode)
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityForResultWithAccount

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

启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;
let options = {
  windowMode: 0
};

try {
  this.context.startAbilityForResultWithAccount(want, accountId, options, (error, result) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbilityForResultWithAccount succeed, result.resultCode = ' +
      result.resultCode)
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityForResultWithAccount

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

启动一个Ability并在该Ability帐号销毁时返回执行结果（promise形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;
let options = {
  windowMode: 0
};

try {
  this.context.startAbilityForResultWithAccount(want, accountId, options)
    .then((result) => {
      // 执行正常业务
      console.log('startAbilityForResultWithAccount succeed, result.resultCode = ' +
        result.resultCode)
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startServiceExtensionAbility

startServiceExtensionAbility(want: Want, callback: AsyncCallback<void>): void;

启动一个新的ServiceExtensionAbility（callback形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};

try {
  this.context.startServiceExtensionAbility(want, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startServiceExtensionAbility succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startServiceExtensionAbility

startServiceExtensionAbility(want: Want): Promise<void>;

启动一个新的ServiceExtensionAbility（Promise形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};

try {
this.context.startServiceExtensionAbility(want)
  .then(() => {
    // 执行正常业务
    console.info('startServiceExtensionAbility succeed');
  })
  .catch((err) => {
    // 处理业务逻辑错误
    console.error(`startServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`);
  });
} catch (err) {
// 处理入参错误异常
console.error(`startServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`);
}

UIAbilityContext.startServiceExtensionAbilityWithAccount

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

启动一个新的ServiceExtensionAbility（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startServiceExtensionAbilityWithAccount succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startServiceExtensionAbilityWithAccount

startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise<void>;

启动一个新的ServiceExtensionAbility（Promise形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.startServiceExtensionAbilityWithAccount(want, accountId)
    .then((data) => {
      // 执行正常业务
      console.log('startServiceExtensionAbilityWithAccount succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.stopServiceExtensionAbility

stopServiceExtensionAbility(want: Want, callback: AsyncCallback<void>): void;

停止同一应用程序内的服务（callback形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};

try {
  this.context.stopServiceExtensionAbility(want, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('stopServiceExtensionAbility succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.stopServiceExtensionAbility

stopServiceExtensionAbility(want: Want): Promise<void>;

停止同一应用程序内的服务（Promise形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};

try {
  this.context.stopServiceExtensionAbility(want)
    .then((data) => {
      // 执行正常业务
      console.log('stopServiceExtensionAbility succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.stopServiceExtensionAbilityWithAccount

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

使用帐户停止同一应用程序内的服务（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('stopServiceExtensionAbilityWithAccount succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.stopServiceExtensionAbilityWithAccount

stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise<void>;

使用帐户停止同一应用程序内的服务（Promise形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
    .then((data) => {
      // 执行正常业务
      console.log('stopServiceExtensionAbilityWithAccount succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.terminateSelf

terminateSelf(callback: AsyncCallback<void>): void;

停止Ability自身（callback形式）。

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

this.context.terminateSelf((error) => {
  if (error.code) {
    // 处理业务逻辑错误
    console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
      ' error.message: ' + JSON.stringify(error.message));
    return;
  }
  // 执行正常业务
  console.log('terminateSelf succeed');
});

UIAbilityContext.terminateSelf

terminateSelf(): Promise<void>;

停止Ability自身（promise形式）。

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

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

this.context.terminateSelf().then((data) => {
  // 执行正常业务
  console.log('terminateSelf succeed');
}).catch((error) => {
  // 处理业务逻辑错误
  console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
    ' error.message: ' + JSON.stringify(error.message));
});

UIAbilityContext.terminateSelfWithResult

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

停止当前的Ability。如果该Ability是通过调用startAbilityForResult接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用startAbilityForResult接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  bundleName: 'com.extreme.myapplication',
  abilityName: 'SecondAbility'
}
let resultCode = 100;
// 返回给接口调用方AbilityResult信息
let abilityResult = {
  want,
  resultCode
}

try {
  this.context.terminateSelfWithResult(abilityResult, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('terminateSelfWithResult succeed');
  });
} catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.terminateSelfWithResult

terminateSelfWithResult(parameter: AbilityResult): Promise<void>;

停止当前的Ability。如果该Ability是通过调用startAbilityForResult接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用startAbilityForResult接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（promise形式）。

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  bundleName: 'com.extreme.myapplication',
  abilityName: 'SecondAbility'
}
let resultCode = 100;
// 返回给接口调用方AbilityResult信息
let abilityResult = {
  want,
  resultCode
}

try {
  this.context.terminateSelfWithResult(abilityResult)
    .then((data) => {
      // 执行正常业务
      console.log('terminateSelfWithResult succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.connectServiceExtensionAbility

connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;

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

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
deviceId: '',
bundleName: 'com.example.myapplication',
abilityName: 'ServiceExtensionAbility'
};
let commRemote;
let options = {
onConnect(elementName, remote) {
  commRemote = remote;
  console.info('onConnect...')
},
onDisconnect(elementName) {
  console.info('onDisconnect...')
},
onFailed(code) {
  console.info('onFailed...')
}

let connection = null;
try {
  connection = this.context.connectServiceExtensionAbility(want, options);
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.connectServiceExtensionAbilityWithAccount

connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;

使用AbilityInfo.AbilityType.SERVICE模板和account将当前Ability连接到一个Ability。

需要权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
deviceId: '',
bundleName: 'com.example.myapplication',
abilityName: 'ServiceExtensionAbility'
};
let accountId = 100;
let commRemote;
let options = {
onConnect(elementName, remote) {
  commRemote = remote;
  console.info('onConnect...')
},
onDisconnect(elementName) {
  console.info('onDisconnect...')
},
onFailed(code) {
  console.info('onFailed...')
}

let connection = null;
try {
  connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.disconnectServiceExtensionAbility

disconnectServiceExtensionAbility(connection: number): Promise<void>;

断开连接（promise形式）。

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

// connection为connectServiceExtensionAbility中的返回值
let connection = 1;

try {
  this.context.disconnectServiceExtensionAbility(connection)
    .then((data) => {
      // 执行正常业务
      console.log('disconnectServiceExtensionAbility succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.disconnectServiceExtensionAbility

disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback<void>): void;

断开连接（callback形式）。

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

// connection为connectServiceExtensionAbility中的返回值
let connection = 1;
let commRemote;

try {
this.context.disconnectServiceExtensionAbility(connection, (err) => {
  commRemote = null;
  if (err.code) {
    // 处理业务逻辑错误
    console.error(`disconnectServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  // 执行正常业务
  console.info('disconnectServiceExtensionAbility succeed');
});
} catch (err) {
commRemote = null;
// 处理入参错误异常
console.error(`disconnectServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`);
}

try {
  this.context.disconnectServiceExtensionAbility(connection, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('disconnectServiceExtensionAbility succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityByCall

startAbilityByCall(want: Want): Promise<Caller>;

启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。

使用规则：

• 调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
• 目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
• 组件启动规则详见：组件启动规则（Stage模型）

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

后台启动：

let caller = undefined;

// 后台启动Ability，不配置parameters
let wantBackground = {
    bundleName: 'com.example.myservice',
    moduleName: 'entry',
    abilityName: 'MainAbility',
    deviceId: ''
};

try {
  this.context.startAbilityByCall(wantBackground)
    .then((obj) => {
      // 执行正常业务
      caller = obj;
      console.log('startAbilityByCall succeed');
    }).catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

前台启动：

let caller = undefined;

// 前台启动Ability，将parameters中的'ohos.aafwk.param.callAbilityToForeground'配置为true
let wantForeground = {
    bundleName: 'com.example.myservice',
    moduleName: 'entry',
    abilityName: 'MainAbility',
    deviceId: '',
    parameters: {
      'ohos.aafwk.param.callAbilityToForeground': true
    }
};

try {
  this.context.startAbilityByCall(wantForeground)
    .then((obj) => {
      // 执行正常业务
      caller = obj;
      console.log('startAbilityByCall succeed');
    }).catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityWithAccount

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

根据account启动Ability（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;

try {
  this.context.startAbilityWithAccount(want, accountId, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbilityWithAccount succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityWithAccount

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

根据account启动Ability（callback形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;
let options = {
  windowMode: 0
};

try {
  this.context.startAbilityWithAccount(want, accountId, options, (error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('startAbilityWithAccount succeed');
  });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.startAbilityWithAccount

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

根据account启动Ability（Promise形式）。

需要权限: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let want = {
  deviceId: '',
  bundleName: 'com.extreme.test',
  abilityName: 'MainAbility'
};
let accountId = 100;
let options = {
  windowMode: 0
};

try {
  this.context.startAbilityWithAccount(want, accountId, options)
    .then((data) => {
      // 执行正常业务
      console.log('startAbilityWithAccount succeed');
    })
    .catch((error) => {
      // 处理业务逻辑错误
      console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
  // 处理入参错误异常
  console.log('error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
}

UIAbilityContext.requestPermissionsFromUser

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

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

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

参数：

示例：

     let permissions=['com.example.permission']
     this.context.requestPermissionsFromUser(permissions,(result) => {
     console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
});

UIAbilityContext.requestPermissionsFromUser

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

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

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

参数：

返回值：

示例：

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

UIAbilityContext.setMissionLabel

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

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

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

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

UIAbilityContext.setMissionLabel

setMissionLabel(label: string): Promise<void>;

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

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

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

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

UIAbilityContext.setMissionIcon

setMissionIcon(icon: image.PixelMap, callback:AsyncCallback<void>): void;

设置当前ability在任务中显示的图标（callback形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

  import image from '@ohos.multimedia.image';
  let imagePixelMap;
  let color = new ArrayBuffer(0);
  let initializationOptions = {
     size: {
         height: 100,
         width: 100
     }
  };
  image.createPixelMap(color, initializationOptions)
     .then((data) => {
         imagePixelMap = data;
     })
     .catch((err) => {
         console.log('--------- createPixelMap fail, err: ---------', err)
     });
  this.context.setMissionIcon(imagePixelMap, (err) => {
     console.log('---------- setMissionIcon fail, err: -----------', err);
  })

UIAbilityContext.setMissionIcon

setMissionIcon(icon: image.PixelMap): Promise<void>;

设置当前ability在任务中显示的图标（promise形式）。

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

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

  import image from '@ohos.multimedia.image';
  let imagePixelMap;
  let color = new ArrayBuffer(0);
  let initializationOptions = {
    size: {
        height: 100,
        width: 100
    }
  };
  image.createPixelMap(color, initializationOptions)
    .then((data) => {
        imagePixelMap = data;
    })
    .catch((err) => {
        console.log('--------- createPixelMap fail, err: ---------', err)
    });
  this.context.setMissionIcon(imagePixelMap)
    .then(() => {
        console.log('-------------- setMissionIcon success -------------');
    })
    .catch((err) => {
        console.log('-------------- setMissionIcon fail, err: -------------', err);
    });

UIAbilityContext.restoreWindowStage

restoreWindowStage(localStorage: LocalStorage) : void;

恢复ability中的window stage数据。

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

参数：

错误码：

错误码详细介绍请参考errcode-ability

示例：

  let storage = new LocalStorage();
  this.context.restoreWindowStage(storage);

UIAbilityContext.isTerminating

isTerminating(): boolean;

查询ability是否在terminating状态。

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

返回值：

错误码：

错误码详细介绍请参考errcode-ability

示例：

let isTerminating = this.context.isTerminating();
console.log('ability state :' + isTerminating);