status/local/index

@boldpenguin/sdk-redux › Globals › "status/local/index"

Index

Variables

• getSdkHealth
• getSdkState
• getSdkWebSocketConnectionState
• isSdkAuthenticated
• isSdkAuthenticatedAndUserLoaded
• isSdkConfigured
• isSdkLoading
• isSdkReady
• isSdkTokenLoaded
• isSdkUserLoaded

Functions

• getSdkStatus

Variables

Const getSdkHealth

• getSdkHealth: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.health)

Returns SDK health indication

param The BpSdk Redux store

---

Const getSdkState

• getSdkState: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.state)

Returns SDK state indication

param The BpSdk Redux store

---

Const getSdkWebSocketConnectionState

• getSdkWebSocketConnectionState: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.socket)

Returns the connection state the SDK web socket

param The BpSdk Redux store

---

Const isSdkAuthenticated

• isSdkAuthenticated: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.auth === SdkStates.Configured)

Returns true if SDK is fully configured with authentication

param The BpSdk Redux store

---

Const isSdkAuthenticatedAndUserLoaded

• isSdkAuthenticatedAndUserLoaded: function & OutputSelectorFields‹function› & object = createSelector( getSdkStatus, (status) => status.auth === SdkStates.Configured && status.user === SdkStates.Configured )

Returns true if SDK is fully configured with authentication and user information is known

param The BpSdk Redux store

---

Const isSdkConfigured

• isSdkConfigured: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.config === SdkStates.Configured)

Returns true if SDK is fully configured with settings

param The BpSdk Redux store

---

Const isSdkLoading

• isSdkLoading: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.state === SdkStates.Loading)

Returns flag if any part of the SDK is currently loading

param The BpSdk Redux store

---

Const isSdkReady

• isSdkReady: function & OutputSelectorFields‹function› & object = createSelector( getSdkStatus, (status) => status.auth === SdkStates.Configured && status.config === SdkStates.Configured && status.user === SdkStates.Configured )

Returns true if SDK is fully configured with authentication and settings

param The BpSdk Redux store

---

Const isSdkTokenLoaded

• isSdkTokenLoaded: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.auth === SdkStates.Configured)

Returns true if SDK has token set

param The BpSdk Redux store

---

Const isSdkUserLoaded

• isSdkUserLoaded: function & OutputSelectorFields‹function› & object = createSelector(getSdkStatus, (status) => status.user === SdkStates.Configured)

Returns true if SDK has user information set

param The BpSdk Redux store

Functions

Const getSdkStatus

▸ getSdkStatus(state: BpSdkStore): typeof LocalState

Returns overall SDK status

Parameters:

Name	Type	Description
state	BpSdkStore	The BpSdk Redux store

Returns: typeof LocalState