\n\n## Maintainers\n\n| Maintainer | GitHub | Social |\n| ------------- | ------------------------------------------- | ------------------------------------------------ |\n| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\\_](https://twitter.com/priyankpat_) |\n\n## Installation\n\nUsing npm:\n\n```bash\nnpm install @capacitor-community/realm\n```\n\nUsing yarn:\n\n```bash\nyarn add @capacitor-community/realm\n```\n\nSync native files:\n\n```bash\nnpx cap sync\n```\n\nOn iOS, no further steps are needed.\n\nOn Android, make changes to the following files:\n\n`MainActivity.java`:\n\n```java\nimport com.getcapacitor.community.realm.Realm;\n\npublic class MainActivity extends BridgeActivity {\n\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(\n savedInstanceState,\n new ArrayList>() {\n\n {\n // Additional plugins you've installed go here\n // Ex: add(TotallyAwesomePlugin.class);\n add(Realm.class);\n }\n }\n );\n }\n}\n```\n\n## Supported methods\n\n| Name | Android | iOS | Web |\n| :------------------------ | :------ | :-- | :-- |\n| initialize | ✅ | ✅ | ✅ |\n| signInAnonymously | ✅ | ✅ | ✅ |\n| logout | ✅ | ✅ | ✅ |\n| signInWithEmailPassword | ✅ | ✅ | ✅ |\n| signInWithApiKey | ✅ | ✅ | ✅ |\n| signInWithJWT | ✅ | ✅ | ✅ |\n| signInWithGoogle | ✅ | ✅ | ✅ |\n| signInWithFacebook | ✅ | ✅ | ✅ |\n| signInWithApple | ✅ | ✅ | ✅ |\n| registerWithEmailPassword | ✅ | ✅ | ✅ |\n| confirmEmail | ✅ | ✅ | ✅ |\n| resetPassword | ✅ | ✅ | ✅ |\n| sendPasswordResetEmail | ✅ | ✅ | ✅ |\n\n## Usage\n\n```typescript\nimport { Plugins } from \"@capacitor/core\";\n\nconst { Realm } = Plugins;\n\n/**\n * Platform: Android/iOS/Web\n * Initialize Realm with the correct Application Id\n * @params appId - This ID is unique to this application. It is necessary for connecting any client to Realm.\n * @returns void\n */\nRealm.initialize({\n appId: '{{APP_ID}}',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#anonymous\n * The anonymous authentication provider enables users to log in to your application with short-term accounts that store no persistent personal information.\n * @params none\n * @returns void\n */\nRealm.signInAnonymously();\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#email-password\n * The Email/Password authentication provider enables users to log in to your application with an email username and a password.\n * @params none\n * @returns void\n */\nRealm.signInWithEmailPassword({\n email: '',\n password: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * The API authentication provider enables users to log in to your application with an API key.\n * @params none\n * @returns void\n */\nRealm.signInWithApiKey({\n apiKey: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#android-login-custom-jwt\n * The Custom JWT authentication provider enables users to log in to your application with a custom JSON Web Token.\n * @params jwtToken - custom jwt token\n * @returns void\n */\nRealm.signInWithJWT({\n jwtToken: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#google-oauth\n * The Google OAuth authentication provider enables users to log in to your application with a custom token provided by Google.\n * @params googleToken - token obtained from google\n * @returns void\n */\nRealm.signInWithGoogle({\n googleToken: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#facebook-oauth\n * The Facebook OAuth authentication provider enables users to log in to your application with a custom token provided by Facebook.\n * @params accessToken - token obtained from facebook\n * @returns void\n */\nRealm.signInWithFacebook({\n accessToken: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#sign-in-with-apple\n * The Sign-in with Apple authentication provider enables users to log in to your application with a custom token provided by Apple.\n * @params idToken - token obtained from apple\n * @returns void\n */\nRealm.signInWithApple({\n idToken: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/authenticate/#log-out\n * The method will log out any user, regardless of the authentication provider.\n * @params none\n * @returns void\n */\nRealm.logout();\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/manage-email-password-users/#register-a-new-user-account\n * The method will register a user with email/password authentication provider.\n * @params email - unique email address\n * password - secure password\n * @returns void\n */\nRealm.registerWithEmailPassword({\n email: '',\n password: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/manage-email-password-users/#confirm-a-new-user-s-email-address\n * The method will confirm a user with email/password authentication provider.\n * @params token - parameters in the confirmation link sent in the confirmation email\n * tokenId - parameters in the confirmation link sent in the confirmation email\n * @returns void\n */\nRealm.confirmEmail({\n token: '',\n tokenId: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * https://docs.mongodb.com/realm/android/manage-email-password-users/#reset-a-user-s-password\n * The method will confirm a user with email/password authentication provider.\n * @params token - parameters in the confirmation link sent in the confirmation email\n * tokenId - parameters in the confirmation link sent in the confirmation email\n * newPassword - new secure password\n * @returns void\n */\nRealm.resetPassword({\n token: '',\n tokenId: '',\n newPassword: '',\n});\n\n/**\n * Platform: Android/iOS/Web\n * The method will resend password reset email.\n * @params email - email address of account that requires password reset\n * @returns void\n */\nRealm.sendPasswordResetEmail({\n email: '',\n});\n\n```\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\")
![](\"https://img.shields.io/maintenance/yes/2020?style=flat-square\")
![](\"https://img.shields.io/github/workflow/status/capacitor-community/realm/Test%20and%20Build%20Plugin?style=flat-square\")
![](\"https://img.shields.io/npm/l/@capacitor-community/realm?style=flat-square\")
![](\"https://img.shields.io/npm/dw/@capacitor-community/realm?style=flat-square\")
![](\"https://img.shields.io/npm/v/@capacitor-community/realm?style=flat-square\")
![](\"https://img.shields.io/badge/all%20contributors-3-orange?style=flat-square\"){kind=icon}