@ohos.cooperate (Screen Hopping)

The cooperate module implements screen hopping for two or more networked devices to share the keyboard and mouse for collaborative operations.

NOTE

• The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs provided by this module are system APIs.

Modules to Import

import cooperate from '@ohos.cooperate'

cooperate.prepare

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

Prepares for screen hopping. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Example

import { BusinessError } from '@ohos.base';
try {
  cooperate.prepare((error: BusinessError) => {
    if (error) {
      console.log(`Keyboard mouse crossing prepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Keyboard mouse crossing prepare success.`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing prepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.prepare

prepare(): Promise<void>

Prepares for screen hopping. This API uses a promise to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Return value

Example

import { BusinessError } from '@ohos.base';
try {
  cooperate.prepare().then(() => {
    console.log(`Keyboard mouse crossing prepare success.`);
  }, (error: BusinessError) => {
    console.log(`Keyboard mouse crossing prepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing prepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.unprepare

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

Cancels the preparation for screen hopping. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Example

import { BusinessError } from '@ohos.base';
try {
  cooperate.unprepare((error: BusinessError) => {
    if (error) {
      console.log(`Keyboard mouse crossing unprepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Keyboard mouse crossing unprepare success.`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing unprepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.unprepare

unprepare(): Promise<void>;

Cancels the preparation for screen hopping. This API uses a promise to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Return value

import { BusinessError } from '@ohos.base';
try {
  cooperate.unprepare().then(() => {
    console.log(`Keyboard mouse crossing unprepare success.`);
  }, (error: BusinessError) => {
    console.log(`Keyboard mouse crossing unprepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing unprepare failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.activate

activate(targetNetworkId: string, inputDeviceId: number, callback: AsyncCallback<void>): void;

Starts screen hopping. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Error codes

For details about the error codes, see Screen Hopping Error Codes.

Example

import { BusinessError } from '@ohos.base';
let targetNetworkId = "networkId";
let inputDeviceId = 0;
try {
  cooperate.activate(targetNetworkId, inputDeviceId, (error: BusinessError) => {
    if (error) {
      console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Start Keyboard mouse crossing success.`);
  });
} catch (error) {
  console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.activate

activate(targetNetworkId: string, inputDeviceId: number): Promise<void>;

Starts screen hopping. This API uses a promise to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Return value

Error codes

For details about the error codes, see Screen Hopping Error Codes.

Example

import { BusinessError } from '@ohos.base';
let targetNetworkId = "networkId";
let inputDeviceId = 0;
try {
 cooperate.activate(targetNetworkId, inputDeviceId).then(() => {
    console.log(`Start Keyboard mouse crossing success.`);
  }, (error: BusinessError) => {
    console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.deactivate

deactivate(isUnchained: boolean, callback: AsyncCallback<void>): void;

Stops screen hopping. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Example

import { BusinessError } from '@ohos.base';
try {
  cooperate.deactivate(false, (error: BusinessError) => {
    if (error) {
      console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Stop Keyboard mouse crossing success.`);
  });
} catch (error) {
  console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.deactivate

deactivate(isUnchained: boolean): Promise<void>;

Stops screen hopping. This API uses a promise to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
try {
  cooperate.deactivate(false).then(() => {
    console.log(`Stop Keyboard mouse crossing success.`);
  }, (error: BusinessError) => {
    console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.getCrossingSwitchState

getCrossingSwitchState(networkId: string, callback: AsyncCallback<boolean>): void;

Obtains the screen hopping status of the target device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Example

import { BusinessError } from '@ohos.base';
let deviceDescriptor = "networkId";
try {
  cooperate.getCrossingSwitchState(deviceDescriptor, (error: BusinessError, data: boolean) => {
    if (error) {
      console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Get the status success, data: ${JSON.stringify(data)}`);
  });
} catch (error) {
  console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

cooperate.getCrossingSwitchState

getCrossingSwitchState(networkId: string): Promise<boolean>;

Obtains the screen hopping status of the target device. This API uses a promise to return the result.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
let deviceDescriptor = "networkId";
try {
  cooperate.getCrossingSwitchState(deviceDescriptor).then((data: boolean) => {
    console.log(`Get the status success, data: ${JSON.stringify(data)}`);
  }, (error: BusinessError) => {
    console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

on('cooperate')

on(type: 'cooperate', callback: Callback<{ networkId: string, msg: CooperateMsg }>): void;

Enables listening for screen hopping status change events.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Example

function callback(networkId: string, msg: cooperate.CooperateMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(networkId)}`);
  return false;
}
try {
  cooperate.on('cooperate', callback);
} catch (error) {
  console.log(`Register failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

off('cooperate')

off(type: 'cooperate', callback?: Callback<void>): void;

Disables listening for screen hopping status change events.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate

Parameters

Example

// Unregister a single callback.
function callbackOn(networkId: string, msg: cooperate.CooperateMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(networkId)}`);
  return false;
}
function callbackOff() {
  console.log(`Keyboard mouse crossing event`);
  return false;
}
try {
  cooperate.on('cooperate', callbackOn);
  cooperate.off('cooperate', callbackOff);
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// Unregister all callbacks.
function callbackOn(networkId: string, msg: cooperate.CooperateMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(networkId)}`);
  return false;
}
try {
  cooperate.on('cooperate', callbackOn);
  cooperate.off('cooperate');
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

CooperateMsg

Represents a screen hopping message notification.

System capability: SystemCapability.Msdp.DeviceStatus.Cooperate