HyprAppProfileData

HYPR SDK for Android: HYPR Adapter Reference

All Superinterfaces:: java.io.Serializable

public interface HyprAppProfileData
extends java.io.Serializable

Method Summary

All Methods
Modifier and Type	Method and Description
`void`	`addRpSendHeader(android.content.Context context, java.lang.String key, java.lang.String value)` Call to add to the Current Application RP Send Headers.
`HyprUserProfileData`	`addUserProfile(android.content.Context context, java.lang.String userProfileName)` Call to add a new User Profile to App Profile.
`java.lang.String`	`getAppProfileName()`
`HyprUserProfileData`	`getCurHyprUserProfileData()` Call to get the Current User Profile Data Object.
`java.lang.String`	`getCurHyprUserProfileDataDbId()` Call to get the Current User Profile DB ID.
`java.lang.String`	`getDbId()`
`HyprApiEndpoints`	`getHyprApiEndpoints()`
`java.util.List<HyprMachineProfileData>`	`getHyprMachineProfileDatas()` Call to get the list of Machine Profile Data Objects.
`HyprRpAppType`	`getHyprRpAppType()`
`HyprUserProfileData`	`getHyprUserProfileDataByDbId(java.lang.String dbId)` Call to get a User Profile Data Object by passed in DB ID.
`java.util.List<HyprUserProfileData>`	`getHyprUserProfileDatas()` Call to get the list of User Profile Data Objects.
`int`	`getNegotiatedRpVersion(android.content.Context context)`
`int`	`getReadTimeoutSec()` Call to get the Current Application RP Read Timeout.
`java.util.Map<java.lang.String,java.lang.String>`	`getRpReceiveHeaders()` Call to get the Current Application RP Receive Headers.
`java.util.Map<java.lang.String,java.lang.String>`	`getRpSendHeaders()` Call to get the Current Application RP Send Headers.
`boolean`	`isOfflineModeEnabled()` Call to determine if the Offline Mode for this Machine Profile is enabled.
`void`	`resetRpAllHeaders(android.content.Context context)` Call to reset the Current Application RP Send and Receive Headers.
`void`	`resetRpReceiveHeaders(android.content.Context context)` Call to reset the Current Application RP Receive Headers.
`void`	`resetRpSendHeaders(android.content.Context context)` Call to reset the Current Application RP Send Headers.
`void`	`setAppProfileName(android.content.Context context, java.lang.String appProfileName)` Call to change the name of the App Profile to the passed in name.
`void`	`setBaseDomainUrl(android.content.Context context, java.lang.String domainUrl)`
`void`	`setCurHyprUserProfileDataByDbId(android.content.Context context, java.lang.String userProfileDbId)` Call to set the Current User Profile Data by passed in DB ID.
`void`	`setCustomerConfiguredDefaultRpVersion(android.content.Context context, int rpVersion)`
`void`	`setFidoClientClass(java.lang.Class fidoClientClass)`
`void`	`setFirebaseGcmSender(android.content.Context context, java.lang.String gcmSender)`
`void`	`setHyprRpAppType(android.content.Context context, HyprRpAppType hyprRpAppType)`
`void`	`setOobEnabled(android.content.Context context, boolean oobEnabled)`
`void`	`setPostOobSetupScreenEnabled(android.content.Context context, boolean isPostOobSetupScreenEnabled)`
`void`	`setPreOobSetupScreenEnabled(android.content.Context context, boolean isPreOobSetupScreenEnabled)`
`void`	`setPushAppType(android.content.Context context, HyprPushAppType pushAppType)`
`void`	`setReadTimeoutSec(android.content.Context context, int readTimeoutSec)` Call to set the Current Application RP Read Timeout.
`void`	`setRelyingPartyType(android.content.Context context, RelyingPartyType relyingPartyType)`
`void`	`setRpAppActionIdAuth(android.content.Context context, java.lang.String rpAppActionId)`
`void`	`setRpAppActionIdAuthStepUp(android.content.Context context, java.lang.String rpAppActionId)`
`void`	`setRpAppActionIdReg(android.content.Context context, java.lang.String rpAppActionId)`
`void`	`setRpAppId(android.content.Context context, java.lang.String rpAppId)`
`void`	`setRpSendHeaders(android.content.Context context, java.util.Map<java.lang.String,java.lang.String> headers)` Call to set the Current Application RP Send Headers.
`void`	`setSslEnabled(android.content.Context context, boolean sslEnabled)`
`void`	`setSslPattern(android.content.Context context, java.lang.String sslPattern)`
`void`	`setSslPins(android.content.Context context, java.util.List<java.lang.String> sslPins)`
`void`	`setStartScreenEnabled(android.content.Context context, boolean isStartScreenEnabled)`

Method Detail

getDbId
```
@NonNull
java.lang.String getDbId()
```

getAppProfileName

@NonNull
java.lang.String getAppProfileName()

setPushAppType

void setPushAppType(@NonNull
                    android.content.Context context,
                    @NonNull
                    HyprPushAppType pushAppType)

setFirebaseGcmSender

void setFirebaseGcmSender(@NonNull
                          android.content.Context context,
                          @NonNull
                          java.lang.String gcmSender)

setFidoClientClass

void setFidoClientClass(@Nullable
                        java.lang.Class fidoClientClass)

getHyprApiEndpoints
```
HyprApiEndpoints getHyprApiEndpoints()
```

setBaseDomainUrl

void setBaseDomainUrl(@NonNull
                      android.content.Context context,
                      @NonNull
                      java.lang.String domainUrl)

setOobEnabled

void setOobEnabled(@NonNull
                   android.content.Context context,
                   boolean oobEnabled)

setSslEnabled

void setSslEnabled(@NonNull
                   android.content.Context context,
                   boolean sslEnabled)

setSslPins

void setSslPins(@NonNull
                android.content.Context context,
                @NonNull
                java.util.List<java.lang.String> sslPins)

setSslPattern

void setSslPattern(@NonNull
                   android.content.Context context,
                   @NonNull
                   java.lang.String sslPattern)

setRpAppId

void setRpAppId(@NonNull
                android.content.Context context,
                @NonNull
                java.lang.String rpAppId)

getHyprRpAppType
```
HyprRpAppType getHyprRpAppType()
```

setHyprRpAppType

void setHyprRpAppType(@NonNull
                      android.content.Context context,
                      @NonNull
                      HyprRpAppType hyprRpAppType)

setRelyingPartyType

void setRelyingPartyType(@NonNull
                         android.content.Context context,
                         @NonNull
                         RelyingPartyType relyingPartyType)

setCustomerConfiguredDefaultRpVersion

void setCustomerConfiguredDefaultRpVersion(@NonNull
                                           android.content.Context context,
                                           int rpVersion)

getNegotiatedRpVersion

int getNegotiatedRpVersion(@NonNull
                           android.content.Context context)

setRpAppActionIdReg

void setRpAppActionIdReg(@NonNull
                         android.content.Context context,
                         @NonNull
                         java.lang.String rpAppActionId)

setRpAppActionIdAuth

void setRpAppActionIdAuth(@NonNull
                          android.content.Context context,
                          @NonNull
                          java.lang.String rpAppActionId)

setRpAppActionIdAuthStepUp

void setRpAppActionIdAuthStepUp(@NonNull
                                android.content.Context context,
                                @NonNull
                                java.lang.String rpAppActionId)

isOfflineModeEnabled

boolean isOfflineModeEnabled()

 Call to determine if the Offline Mode for this Machine Profile is enabled.

Returns:: If Offline Mode is enabled

setStartScreenEnabled

void setStartScreenEnabled(@NonNull
                           android.content.Context context,
                           boolean isStartScreenEnabled)
                    throws HyprException

Throws:: HyprException

setPreOobSetupScreenEnabled

void setPreOobSetupScreenEnabled(@NonNull
                                 android.content.Context context,
                                 boolean isPreOobSetupScreenEnabled)
                          throws HyprException

Throws:: HyprException

setPostOobSetupScreenEnabled

void setPostOobSetupScreenEnabled(@NonNull
                                  android.content.Context context,
                                  boolean isPostOobSetupScreenEnabled)
                           throws HyprException

Throws:: HyprException

getRpSendHeaders

@NonNull
java.util.Map<java.lang.String,java.lang.String> getRpSendHeaders()
                                                                    throws HyprException

Call to get the Current Application RP Send Headers.

Returns:
Throws:: HyprException

setRpSendHeaders

void setRpSendHeaders(@NonNull
                      android.content.Context context,
                      @NonNull
                      java.util.Map<java.lang.String,java.lang.String> headers)
               throws HyprException

Call to set the Current Application RP Send Headers.

Parameters:: context -; headers -
Throws:: HyprException

addRpSendHeader

void addRpSendHeader(@NonNull
                     android.content.Context context,
                     @NonNull
                     java.lang.String key,
                     @NonNull
                     java.lang.String value)
              throws HyprException

Call to add to the Current Application RP Send Headers.

Parameters:: context -; key -; value -
Throws:: HyprException

resetRpSendHeaders

void resetRpSendHeaders(@NonNull
                        android.content.Context context)
                 throws HyprException

Call to reset the Current Application RP Send Headers.

Parameters:: context -
Throws:: HyprException

getRpReceiveHeaders

@NonNull
java.util.Map<java.lang.String,java.lang.String> getRpReceiveHeaders()
                                                                       throws HyprException

Call to get the Current Application RP Receive Headers.

Returns:
Throws:: HyprException

resetRpReceiveHeaders

void resetRpReceiveHeaders(@NonNull
                           android.content.Context context)
                    throws HyprException

Call to reset the Current Application RP Receive Headers.

Parameters:: context -
Throws:: HyprException

resetRpAllHeaders

void resetRpAllHeaders(@NonNull
                       android.content.Context context)
                throws HyprException

Call to reset the Current Application RP Send and Receive Headers.

Parameters:: context -
Throws:: HyprException

getReadTimeoutSec
```
int getReadTimeoutSec()
               throws HyprException
```
Call to get the Current Application RP Read Timeout.

Returns:

Throws:

HyprException

setReadTimeoutSec

void setReadTimeoutSec(@NonNull
                       android.content.Context context,
                       int readTimeoutSec)
                throws HyprException

Call to set the Current Application RP Read Timeout.

Parameters:: context -; readTimeoutSec -
Throws:: HyprException

getHyprUserProfileDatas

@NonNull
java.util.List<HyprUserProfileData> getHyprUserProfileDatas()

 Call to get the list of User Profile Data Objects.

Returns:: User Profile Data Objects

getHyprUserProfileDataByDbId

@NonNull
HyprUserProfileData getHyprUserProfileDataByDbId(java.lang.String dbId)
                                                   throws HyprException

 Call to get a User Profile Data Object by passed in DB ID.

Returns:: User Profile Data
Throws:: HyprException - Exception thrown on failure

getCurHyprUserProfileData

@NonNull
HyprUserProfileData getCurHyprUserProfileData()
                                                throws HyprException

 Call to get the Current User Profile Data Object.

Returns:: Current User Profile Data
Throws:: HyprException - Exception thrown on failure

addUserProfile

HyprUserProfileData addUserProfile(@NonNull
                                   android.content.Context context,
                                   @NonNull
                                   java.lang.String userProfileName)
                            throws HyprException

 Call to add a new User Profile to App Profile.

Parameters:: context - Context; userProfileName - User Profile Name
Returns:: New User Profile Data
Throws:: HyprException - Exception thrown on failure

setCurHyprUserProfileDataByDbId

void setCurHyprUserProfileDataByDbId(@NonNull
                                     android.content.Context context,
                                     @NonNull
                                     java.lang.String userProfileDbId)
                              throws HyprException

 Call to set the Current User Profile Data by passed in DB ID.

Parameters:: context - Context; userProfileDbId - User Profile DB ID
Throws:: HyprException - Exception thrown on failure

getCurHyprUserProfileDataDbId

java.lang.String getCurHyprUserProfileDataDbId()
                                        throws HyprException

 Call to get the Current User Profile DB ID.

Returns:: Current User Profile DB ID
Throws:: HyprException - Exception thrown on failure

getHyprMachineProfileDatas

@NonNull
java.util.List<HyprMachineProfileData> getHyprMachineProfileDatas()

 Call to get the list of Machine Profile Data Objects.

Returns:: Machine Profile Data Objects

setAppProfileName

void setAppProfileName(@NonNull
                       android.content.Context context,
                       @NonNull
                       java.lang.String appProfileName)

 Call to change the name of the App Profile to the passed in name.

Parameters:: context - Context; appProfileName - Application Profile Name
Throws:: HyprException - Exception thrown on failure

}

Updated 4 months ago

Interface HyprAppProfileData