@supertokens-plugins/user-banning-react
Type Aliases
SuperTokensPluginUserBanningPluginConfig
type SuperTokensPluginUserBanningPluginConfig = {
bannedUserRole?: string;
onPermissionFailureRedirectPath?: string;
userBanningPermission?: string;
};
Defined in: supertokens-plugins/packages/user-banning-react/src/types.ts:3
Properties
SuperTokensPluginUserBanningPluginNormalisedConfig
type SuperTokensPluginUserBanningPluginNormalisedConfig = {
bannedUserRole: string;
onPermissionFailureRedirectPath: string;
userBanningPermission: string;
};
Defined in: supertokens-plugins/packages/user-banning-react/src/types.ts:9
Properties
TranslationKeys
type TranslationKeys = keyof typeof defaultTranslationsUserBanning["en"];
Defined in: supertokens-plugins/packages/user-banning-react/src/types.ts:15
Variables
API_PATH
const API_PATH: "plugin/supertokens-plugin-user-banning";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:3
default
default: {
init: any;
};
Defined in: supertokens-plugins/packages/user-banning-react/src/index.ts:4
Type Declaration
DEFAULT_BANNED_USER_ROLE
const DEFAULT_BANNED_USER_ROLE: "banned" = "banned";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:6
DEFAULT_ON_PERMISSION_FAILURE_REDIRECT_PATH
const DEFAULT_ON_PERMISSION_FAILURE_REDIRECT_PATH: "/" = "/";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:7
DEFAULT_PERMISSION_NAME
const DEFAULT_PERMISSION_NAME: "ban-user" = "ban-user";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:5
defaultTranslationsUserBanning
const defaultTranslationsUserBanning: {
en: {
PL_UB_BAN_PAGE_BAN_BUTTON: "Ban";
PL_UB_BAN_PAGE_BANNED_STATUS: "Banned";
PL_UB_BAN_PAGE_CHECK_STATUS_BUTTON: "Check Status";
PL_UB_BAN_PAGE_DESCRIPTION: "This page is used to ban and unban users. It is useful for preventing users from accessing your application.";
PL_UB_BAN_PAGE_EMAIL_LABEL: "Email";
PL_UB_BAN_PAGE_EMAIL_PLACEHOLDER: "Enter email";
PL_UB_BAN_PAGE_GENERAL_ERROR: "An error occurred while checking the status of the user";
PL_UB_BAN_PAGE_NOT_BANNED_STATUS: "Not Banned";
PL_UB_BAN_PAGE_TENANT_ID_LABEL: "Tenant";
PL_UB_BAN_PAGE_TENANT_ID_PLACEHOLDER: "Enter tenant ID";
PL_UB_BAN_PAGE_TITLE: "Ban User";
PL_UB_BAN_PAGE_UNBAN_BUTTON: "Unban";
PL_UB_BAN_PAGE_UNKNOWN_ERROR: "An unknown error occurred";
PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE: "An unknown error occurred while checking the status of the user";
PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE_MESSAGE: "An unknown error occurred while checking the status of the user";
};
};
Defined in: supertokens-plugins/packages/user-banning-react/src/translations.ts:1
Type Declaration
enableDebugLogs
enableDebugLogs: any;
Defined in: supertokens-plugins/packages/user-banning-react/src/logger.ts:5
init
const init: any;
Defined in: supertokens-plugins/packages/user-banning-react/src/plugin.ts:36
logDebugMessage
logDebugMessage: any;
Defined in: supertokens-plugins/packages/user-banning-react/src/logger.ts:5
PLUGIN_ID
const PLUGIN_ID: "supertokens-plugin-user-banning" = "supertokens-plugin-user-banning";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:1
PLUGIN_VERSION
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
Defined in: supertokens-plugins/packages/user-banning-react/src/constants.ts:2
ThemeBase
const ThemeBase: React.FC<PropsWithChildren<{
userStyles: (string | undefined)[];
}>>;
Defined in: supertokens-plugins/packages/user-banning-react/src/utils/ThemeBase.tsx:21
usePluginContext
usePluginContext: any;
Defined in: supertokens-plugins/packages/user-banning-react/src/plugin.ts:25
Functions
BanUserPage()
function BanUserPage(): Element;
Defined in: supertokens-plugins/packages/user-banning-react/src/pages/BanUserPage.tsx:12
Returns
Element
getApi()
function getApi(querier: any): {
getBanStatus: (tenantId: string, email: string) => Promise<any>;
updateBanStatus: (tenantId: string, email: string, isBanned: boolean) => Promise<any>;
};
Defined in: supertokens-plugins/packages/user-banning-react/src/api.ts:3
Parameters
Returns
{
getBanStatus: (tenantId: string, email: string) => Promise<any>;
updateBanStatus: (tenantId: string, email: string, isBanned: boolean) => Promise<any>;
}
getErrorMessage()
function getErrorMessage(error: any): string;
Defined in: supertokens-plugins/packages/user-banning-react/src/utils/getErrorMessage.ts:1
Parameters
Returns
string