目录

Policy

Class Info

public class Policy implements Parcelable

定义了一系列消息发布(put)或消息获取(get)的策略。策略由发现模式(FindingMode)和生存时间值(TTL,全称Time To Live)等组成。

Nested Class Summary

Qualifier and Type

Class Name and Description

static class

Policy.Builder

Policy的构造类。

Public Field Summary

Qualifier and Type

Field and Description

static final Policy

BLE_ONLY

Policy的配置参数为BLE_ONLY。

static final Parcelable.Creator<Policy>

CREATOR

实现Parcelable接口必须提供的实例。

static final Policy

DEFAULT

Policy的默认配置参数。

static final int

POLICY_DISTANCE_TYPE_DEFAULT

允许任何距离范围的消息传输,此处距离最大为蓝牙信号有效距离。

static final int

POLICY_DISTANCE_TYPE_EARSHOT

允许听力所及范围内的消息传输,此处范围指超声波传输范围。

static final int

POLICY_FINDING_MODE_BROADCAST

此发现模式下,仅支持向外广播,扫描功能被限制。

static final int

POLICY_FINDING_MODE_DEFAULT

此发现模式下,同时允许广播和扫描。

static final int

POLICY_FINDING_MODE_SCAN

此发现模式下,仅支持扫描近场设备,广播功能被限制。

static final int

POLICY_TTL_SECONDS_DEFAULT

默认超时时间(单位:秒)。

static final int

POLICY_TTL_SECONDS_INFINITE

超时时间为无限期。

static final int

POLICY_TTL_SECONDS_MAX

允许最大超时时间(单位:秒)。

Public Method Summary

Qualifier and Type

Method Name and Description

int

describeContents()

返回当前Parcelable对象描述。

boolean

equals(Object obj)

判断其他对象是否与本实例相同。

int

getDistanceType()

获取当前策略支持距离类型。

int

getFindingMode()

获取当前策略的发现模式类型。

int

getTtlSeconds()

获取当前策略的超时时间。

int

hashCode()

获取哈希值。

String

toString()

把对象转化成可读的字符串。

void

writeToParcel(Parcel dest, int flags)

序列化打包。

Public Fields

[h2]BLE_ONLY

Fields

public static final Policy BLE_ONLY

Policy的配置参数为BLE_ONLY。发现模式为POLICY_FINDING_MODE_SCAN,超时时间为POLICY_TTL_SECONDS_INFINITE。

注意:

注意本策略仅支持在订阅时使用。如果当前机型支持BLE扫描,建议使用本策略模式。

Constant Value:"BLE_ONLY"

[h2]CREATOR

Fields

public static final Parcelable.Creator<Policy> CREATOR

实现Parcelable接口必须提供的实例。

[h2]DEFAULT

Fields

public static final Policy DEFAULT

Policy的默认配置参数。发现模式为POLICY_FINDING_MODE_DEFAULT,超时时间为POLICY_TTL_SECONDS_DEFAULT。

Constant Value:"DEFAULT"

[h2]POLICY_DISTANCE_TYPE_DEFAULT

Fields

public static final int POLICY_DISTANCE_TYPE_DEFAULT

允许任何距离范围的消息传输,此处距离最大为蓝牙信号有效距离。

Constant Value:0

[h2]POLICY_DISTANCE_TYPE_EARSHOT

Fields

public static final int POLICY_DISTANCE_TYPE_EARSHOT

允许听力所及范围内的消息传输,此处范围指超声波传输范围。

注意:

Nearby Message API暂时不支持超声波数据传输,故不支持该距离类型。

Constant Value:1

[h2]POLICY_FINDING_MODE_BROADCAST

Fields

public static final int POLICY_FINDING_MODE_BROADCAST

此发现模式下,仅支持向外广播,扫描功能被限制。

Constant Value:1

[h2]POLICY_FINDING_MODE_DEFAULT

Fields

public static final int POLICY_FINDING_MODE_DEFAULT

此发现模式下,同时允许广播和扫描。

Constant Value:0

[h2]POLICY_FINDING_MODE_SCAN

Fields

public static final int POLICY_FINDING_MODE_SCAN

此发现模式下,仅支持扫描近场设备,广播功能被限制。

Constant Value:2

[h2]POLICY_TTL_SECONDS_DEFAULT

Fields

public static final int POLICY_TTL_SECONDS_DEFAULT

默认超时时间(单位:秒)。

Constant Value:240

[h2]POLICY_TTL_SECONDS_INFINITE

Fields

public static final int POLICY_TTL_SECONDS_INFINITE

超时时间为无限期。

注意:

此TTL当前只支持消息获取(Get)。

Constant Value:0x7FFFFFFF

[h2]POLICY_TTL_SECONDS_MAX

Fields

public static final int POLICY_TTL_SECONDS_MAX

允许最大超时时间,单位:秒。

Constant Value:86400

Public Methods

[h2]describeContents

Method

public int describeContents()

返回当前Parcelable对象描述。

Returns

Type

Description

int

返回当前Parcelable对象描述。返回值如下:

  • 0:普通Parcelable对象。
  • 1:包含文件描述符的Parcelable对象。

[h2]equals

Method

public boolean equals(Object other)

判断其他对象是否与本实例相同。

Parameters

Name

Description

other

其他对象。

Returns

Type

Description

boolean

  • true:相同。
  • false:不相同。

[h2]hashCode

Method

public int hashCode()

获取哈希值。

Returns

Type

Description

int

当前对象的哈希值。

[h2]getDistanceType

Method

public int getDistanceType()

获取当前策略支持距离类型。

Returns

Type

Description

int

当前策略支持距离类型。

  • 0:允许在任何距离上交换消息。
  • 1:只允许在听力范围内进行交换消息。

[h2]getFindingMode

Method

public int getFindingMode()

获取当前策略的发现模式类型。

Returns

Type

Description

int

当前策略的发现模式类型。

[h2]getTtlSeconds

Method

public int getTtlSeconds()

获取当前策略的超时时间。

Returns

Type

Description

int

当前策略的超时时间,单位:秒。

[h2]toString

Method

public String toString()

把对象转化成可读的字符串。

Returns

Type

Description

String

对象转化成的可读字符串。

[h2]writeToParcel

Method

public void writeToParcel(Parcel dest, int flags)

序列化打包,把值写入dest容器。

Parameters

Name

Description

dest

对象被写入的Parcel。

flags

写入方式,取值如下:

  • 0。
  • PARCELABLE_WRITE_RETURN_VALUE(详情查看Parcelable接口类)。