ICDeviceProfile

Holds information about a device and associated user data. Device profiles are registered with the Webex Connect platform to allow targeted communication between the platform and the SDK.

If a device profile is registered without providing a specific appUserId value, the Webex Connect platform will generate one automatically. The currently registered device profile is accessible via IMIconnect.getDeviceProfile.

📘

Note

We recommend using an Instance ID or UUID for your deviceId, the defaultDeviceId is provided as a convenience and uses the standard ANDROID_ID value.

Public Methods

Return Type

Method

String

getAppUserId()
Returns the app user id.


String

getCustomerId()
This method is used to get the Customer ID.


String

getDefaultDeviceId()
Convenient method for obtaining a device id.


String

getDeviceId()
Returns the device id.


boolean

isAppUserSystemGenerated()
Returns true if userId is generated by Webex Connect system, otherwise false.

ICDeviceProfile

Creates an ICDeviceProfile instance with the given deviceId and appUserId.

Syntax: ICDeviceProfile(final String deviceId)

Parameters

Parameter

Type

Description

deviceId

String

A unique identifier for the device

ICDeviceProfile

Creates an ICDeviceProfile instance with the given deviceId and appUserId.

Syntax: ICDeviceProfile(final String deviceId, final String appUserId)

Parameters

Parameter

Type

Description

deviceId

String

A unique identifier for the device

appUserId

String

A unique identifier representing the device user

getAppUserId

Returns the app user id.

Syntax: String getAppUserId()

Returns: Returns the app user id. If an id was not specified when constructing the ICDeviceProfile instance, then it returns the id generated by the Webex Connect platform during registration.

getCustomerId

This method is used to get the Customer ID.

Syntax: String getCustomerId()

Return Value: Returns the customerId associated to the device profile. It must be previously associated by calling the updateProfileData method.

getDefaultDeviceId

Convenient method for obtaining a device id. The id returned is equivalent to Settings.Secure.ANDROID_ID

Syntax: public static String getDefaultDeviceId()

Returns: A default deviceId equivalent to Settings.Secure.ANDROID_ID.

getDeviceId

Returns the device id.

Syntax: String getDeviceId()

Return Value: Returns the device identifier.

isAppUserSystemGenerated

Used to determine if the current appUserId value was generated by the Webex Connect platform.

Syntax: boolean isAppUserSystemGenerated()

Return Value: Returns true if userId is generated by Webex Connect system, otherwise false.