HyprMachineProfileData
HYPR SDK for Android: HYPR Adapter Reference
Interface HyprMachineProfileData
-
- All Superinterfaces:
- java.io.Serializable
public interface HyprMachineProfileData extends java.io.Serializable
-
-
Method Summary
All Methods Modifier and Type Method and Description java.lang.String
getDbId()
Call to get the Machine Profile DB ID.java.util.List<HyprAccessData>
getHyprAccessDatas()
Call to get the Access Data List for the Machine Profile.HyprOfflineData
getHyprOfflineData(android.content.Context context)
Call to get the Offline Data for the Machine Profile.java.lang.String
getMachineDisplayName()
Call to get the Display Name for the Machine Profile.java.lang.String
getMachineId()
Call to get the Machine ID for the Machine Profile.java.lang.String
getMachineName()
Call to get the SDK Assigned Name for the Machine Profile.HyprMachineState
getMachineState()
Call to get the Machine State for the Machine Profile.java.lang.String
getMachineUserName()
Call to get the SDK Assigned Name for the Machine Profile User.boolean
isOfflineValidAndSetup()
Call to determine if the Offline Data for this Machine Profile is valid and setup.boolean
isValidAndSetup()
Call to determine if the Machine Profile is valid and setup.void
setMachineDisplayName(android.content.Context context, java.lang.String machineProfileName)
Call to change the name of the Machine Profile to the passed in name.
-
-
-
Method Detail
-
getDbId
@NonNull java.lang.String getDbId()
Call to get the Machine Profile DB ID.
- Returns:
- Machine Profile Data DB ID
-
isValidAndSetup
boolean isValidAndSetup()
Call to determine if the Machine Profile is valid and setup.
- Returns:
- If the Machine Profile is valid and setup
-
setMachineDisplayName
void setMachineDisplayName(@NonNull android.content.Context context, @NonNull java.lang.String machineProfileName) throws HyprException
Call to change the name of the Machine Profile to the passed in name.
- Parameters:
context
- ContextmachineProfileName
- Machinelication Profile Name, must not be empty String.- Throws:
HyprException
- Exception thrown on failure
-
getMachineId
@NonNull java.lang.String getMachineId()
Call to get the Machine ID for the Machine Profile.
- Returns:
- Machine ID
-
getMachineDisplayName
@NonNull java.lang.String getMachineDisplayName()
Call to get the Display Name for the Machine Profile.
- Returns:
- Machine Profile Display Name
-
getMachineName
@NonNull java.lang.String getMachineName()
Call to get the SDK Assigned Name for the Machine Profile. This name should not be changed.
- Returns:
- Machine Profile Name
-
getMachineUserName
@NonNull java.lang.String getMachineUserName()
Call to get the SDK Assigned Name for the Machine Profile User. This name should not be changed.
- Returns:
- Machine Profile User Name
-
getMachineState
@NonNull HyprMachineState getMachineState()
Call to get the Machine State for the Machine Profile.
- Returns:
- HyprMachineState
-
getHyprAccessDatas
@NonNull java.util.List<HyprAccessData> getHyprAccessDatas()
Call to get the Access Data List for the Machine Profile. It is returned in reverse order, meaning that the latest timestamp entries in the array are at the beginning.
- Returns:
- List of Access Data
-
isOfflineValidAndSetup
boolean isOfflineValidAndSetup()
Call to determine if the Offline Data for this Machine Profile is valid and setup.
- Returns:
- If the Offline Data is valid and setup
-
getHyprOfflineData
@NonNull HyprOfflineData getHyprOfflineData(@NonNull android.content.Context context)
Call to get the Offline Data for the Machine Profile.
- Parameters:
context
- Context- Returns:
- Offline Data
-
-
Updated about 1 month ago