Matter

class Matter


Entry point for Matter APIs.

Summary

Constants

const String!
ACTION_COMMISSION_DEVICE = "com.google.android.gms.home.matter.ACTION_COMMISSION_DEVICE"

android.content.Intent action used to share when an application is chosen from shareDevice.

const String!
ACTION_START_COMMISSIONING = "com.google.android.gms.home.matter.ACTION_START_COMMISSIONING"

Intent action to start a Matter commissioning flow.

const String!
EXTRA_ONBOARDING_PAYLOAD = "com.google.android.gms.home.matter.EXTRA_ONBOARDING_PAYLOAD"

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of an (optional) onboarding payload (manual pairing code or QR code string).

const String!
EXTRA_PRODUCT_ID = "com.google.android.gms.home.matter.EXTRA_PRODUCT_ID"

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of the Matter product ID of the device to be commissioned.

const String!
EXTRA_VENDOR_ID = "com.google.android.gms.home.matter.EXTRA_VENDOR_ID"

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of the Matter vendor ID of the device to be commissioned.

Public functions

java-static CommissioningClient!

Returns a new CommissioningClient.

java-static CommissioningClient!

Returns a new CommissioningClient.

java-static DiscoveryClient!

Returns a new DiscoveryClient.

java-static DiscoveryClient!

Returns a new DiscoveryClient.

java-static SettingsClient!

Returns a new SettingsClient.

java-static SettingsClient!

Returns a new SettingsClient.

Constants

ACTION_COMMISSION_DEVICE

const val ACTION_COMMISSION_DEVICE = "com.google.android.gms.home.matter.ACTION_COMMISSION_DEVICE": String!

android.content.Intent action used to share when an application is chosen from shareDevice.

Upon receiving this android.content.Intent from Google Play Services, you can retrieve the device information from the android.content.Intent using fromIntent.

ACTION_START_COMMISSIONING

const val ACTION_START_COMMISSIONING = "com.google.android.gms.home.matter.ACTION_START_COMMISSIONING": String!

Intent action to start a Matter commissioning flow. This can be used if you have no interest in adding your own fabric to the device, or in receiving a result of success or failure, but simply want to direct the user to a setup flow that will allow them to choose a destination application.

Note that if your application registers an IntentFilter for ACTION_COMMISSION_DEVICE, then your application will be listed as a potential destination application.

EXTRA_ONBOARDING_PAYLOAD

const val EXTRA_ONBOARDING_PAYLOAD = "com.google.android.gms.home.matter.EXTRA_ONBOARDING_PAYLOAD": String!

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of an (optional) onboarding payload (manual pairing code or QR code string). If this is not specified, then the user will be asked to scan the QR code or enter a manual pairing code.

Supported values are the 11-digit manual pairing code, 21-digit manual pairing code, or the raw text of the Matter QR code (including MT: prefix). If an invalid value is received, the QR code scanner will be shown.

Intent extra type: String

EXTRA_PRODUCT_ID

const val EXTRA_PRODUCT_ID = "com.google.android.gms.home.matter.EXTRA_PRODUCT_ID": String!

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of the Matter product ID of the device to be commissioned. If the EXTRA_ONBOARDING_PAYLOAD is provided as a manual pairing code, this should be included to indicate the type of device.

If this is specified then EXTRA_VENDOR_ID must also be specified.

Intent extra type: Integer

EXTRA_VENDOR_ID

const val EXTRA_VENDOR_ID = "com.google.android.gms.home.matter.EXTRA_VENDOR_ID": String!

Intent extra for the ACTION_START_COMMISSIONING action which allows specification of the Matter vendor ID of the device to be commissioned. If the EXTRA_ONBOARDING_PAYLOAD is provided as a manual pairing code, this should be included to indicate the type of device.

If this is specified then EXTRA_PRODUCT_ID must also be specified.

Intent extra type: Integer

Public functions

getCommissioningClient

java-static fun getCommissioningClient(activity: Activity!): CommissioningClient!

Returns a new CommissioningClient.

getCommissioningClient

java-static fun getCommissioningClient(context: Context!): CommissioningClient!

Returns a new CommissioningClient.

getDiscoveryClient

java-static fun getDiscoveryClient(activity: Activity!): DiscoveryClient!

Returns a new DiscoveryClient.

getDiscoveryClient

java-static fun getDiscoveryClient(context: Context!): DiscoveryClient!

Returns a new DiscoveryClient.

getSettingsClient

java-static fun getSettingsClient(activity: Activity!, account: GoogleSignInAccount?): SettingsClient!

Returns a new SettingsClient.

getSettingsClient

java-static fun getSettingsClient(context: Context!, account: GoogleSignInAccount?): SettingsClient!

Returns a new SettingsClient.