Android API Reference
Android API Reference
#Constructor
The Magic class is the entry-point to the Magic SDK. It must be instantiated with a Magic publishable key.
Magic
| Public constructors | |
| Magic(context: Context, apiKey: String) | Construct a Magic instance with publishable API Key retrieved from the Magic Dashboard |
| Magic(context:Context, apiKey: String, network: Magic.EthNetwork) | Construct a Magic instance with publishable Key and Ethereum network |
| Magic(context:Context, apiKey: String, customNode: CustomNodeConfiguration) | Construct a Magic instance with publishable Key and Custom Node configuration |
Example
01class MagicDemoApp: Application() {
02
03 lateinit var magic: Magic
04 override fun onCreate() {
05 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
06 super.onCreate()
07 }
08}
#Auth module
The Auth Module and its members are accessible on the Magic SDK instance by the auth property.
01import link.magic.android.Magic
02
03var magic: Magic
04
05magic.auth;
06magic.auth.loginWithMagicLink;
07magic.auth.loginWithSMS;
08magic.auth.loginWithEmailOTP;
#loginWithMagicLink
#Public Methods
| Methods |
| loginWithMagicLink(context: Context, configuration: LoginWithMagicLinkConfiguration): CompletableFuture<DIDToken> |
#Returns
DIDToken: Response<String>()
The function resolves upon authentication request success and rejects with a specific error code if the request fails. The resolved value is a Decentralized ID token with a default 15-minute lifespan.
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_API_KEY")
09 }
10
11 fun login(v: View) {
12 val email = findViewById<EditText>(R.id.emailInput)
13 val configuration = LoginWithMagicLinkConfiguration(email.text.toString())
14 val completable = magic.auth.loginWithMagicLink(configuration)
15
16 // Logging in
17 completable.whenComplete { response: DIDToken?, error: Throwable? ->
18 if (error != null) {
19 // Handle error
20 }
21 if (response != null && !response.hasError()) {
22 Log.d("Magic", "You're logged in!" + response.result)
23 } else {
24 Log.d("Magic", "Not Logged in")
25 }
26 }
27 }
28}
#Associated Class
LoginWithMagicLinkConfiguration(showUI: Boolean? = true, email: String)
emailThe user email to log in with.showUIIftrue, show an out-of-the-box pending UI while the request is in flight.
#loginWithSMS
Authenticate a user passwordlessly using a one-time code sent to the specified phone number.
List of Currently Blocked Country Codes
#Public Methods
| Methods |
| loginWithSMS(context: Context, configuration: LoginWithSMSConfiguration): CompletableFuture<DIDToken> |
#Returns
DIDToken: Response<String>()
The function resolves upon authentication request success and rejects with a specific error code if the request fails. The resolved value is a Decentralized ID token with a default 15-minute lifespan.
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_API_KEY")
09 }
10
11 fun login(v: View) {
12 val phoneNumber = findViewById<EditText>(R.id.phone_number_input)
13 val configuration = LoginWithSMSConfiguration(phoneNumber.text.toString())
14 val completable = magic.auth.loginWithSMS(configuration)
15
16 // Logging in
17 completable.whenComplete { response: DIDToken?, error: Throwable? ->
18 if (error != null) {
19 // Handle error
20 }
21 if (response != null && !response.hasError()) {
22 Log.d("Magic", "You're logged in!" + response.result)
23 } else {
24 Log.d("Magic", "Not Logged in")
25 }
26 }
27 }
28}
#Associated Class
LoginWithSMSConfiguration(phoneNumber: String)
phoneNumberThe phone number to log in with
#loginWithEmailOTP
Authenticate a user passwordlessly using an email one-time code sent to the specified user's email address.
#Public Methods
| Methods |
| loginWithEmailOTP(context: Context, configuration: LoginWithEmailOTPConfiguration): CompletableFuture<DIDToken> |
#Returns
DIDToken: Response<String>()
The function resolves upon authentication request success and rejects with a specific error code if the request fails. The resolved value is a Decentralized ID token with a default 15-minute lifespan.
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_API_KEY")
09 }
10
11 fun login(v: View) {
12 val email = findViewById<EditText>(R.id.email_input)
13 val configuration = LoginWithEmailOTPConfiguration(email.text.toString())
14 val completable = magic.auth.loginWithEmailOTP(configuration)
15
16 // Logging in
17 completable.whenComplete { response: DIDToken?, error: Throwable? ->
18 if (error != null) {
19 // Handle error
20 }
21 if (response != null && !response.hasError()) {
22 Log.d("Magic", "You're logged in!" + response.result)
23 } else {
24 Log.d("Magic", "Not Logged in")
25 }
26 }
27 }
28}
#Associated Class
LoginWithEmailOTPConfiguration(email: String)
emailThe user email to log in with.
#User Module
The User Module and its members are accessible on the Magic SDK instance by the user property.
01import MagicSDK
02
03let magic = Magic.shared
04
05magic.user
06magic.user.getIdToken
07magic.user.generateIdToken
08magic.user.getMetadata
09magic.user.updateEmail
10magic.user.isLoggedIn
11magic.user.logout
#updateEmail
Initiates the update email flow that allows a user to change to a new email
#Public Methods
| Methods |
| updateEmail(context: Context, configuration: UpdateEmailConfiguration) -> CompletableFuture<UpdateEmailResponse> |
#Returns
UpdateEmailResponse: Response<Boolean>()
The Completable resolves with a true boolean value if update email is successful and rejects with a specific error code if the request fails.
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
09 }
10
11 // ⭐️ Assuming user is logged in
12 fun updateEmail(v: View) {
13
14 val configuration = UpdateEmailConfiguration("new_user_email@example.com")
15 val completable = magic.user.updateEmail(this, configuration)
16 completable.whenComplete { response: UpdateEmailResponse?, error: Throwable? ->
17 if (response != null) {
18 Log.d("Magic", response.result.toString()) // "True"
19 } else {
20 // handle error
21 }
22 }
23 }
24}
#Associated Class
UpdateEmailConfiguration(showUI: Boolean? = true, email: String)
emailThe user email to update with.showUIIftrue, show an out-of-the-box pending UI while the request is in flight.
#getIdToken
Generates a Decentralized Id Token which acts as proof of authentication to resource servers.
#Public Methods
| Methods |
| getIdToken(configuration: GetIdTokenConfiguration?): CompletableFuture<GetIdTokenResponse> |
#Returns
GetIdTokenResponse: Response<String>()
The Completable resolves with a true boolean value if the update email is successful and rejects with a specific error code if the request fails.
01class MagicActivity: AppCompatActivity() {
02 lateinit var magic: Magic
03
04 override fun onCreate(savedInstanceState: Bundle?) {
05 super.onCreate(savedInstanceState)
06
07 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
08 }
09
10 // ⭐️Assuming user is logged in
11 fun getIdToken(v: View) {
12 val configuration = GetIdTokenConfiguration(lifespan = 900)
13 val completable = magic.user.getIdToken(configuration)
14 completable.whenComplete { response: GetIdTokenResponse?, error: Throwable? ->
15 if (response != null) {
16 Log.d("Magic", response.result)
17 } else {
18 // handle Error
19 }
20 }
21 }
22}
#Associated Class
GetIdTokenConfiguration(lifespan: Long? = 900)
lifespan?: will set the lifespan of the generated token. Defaults to 900s (15 mins)
#generateIdToken
Generates a Decentralized Id Token with optional serialized data.
#Public Methods
| Methods |
| generateIdToken(configuration: GenerateIdTokenConfiguration?): CompletableFuture<GenerateIdTokenResponse> |
#Returns
GenerateIdTokenResponse: Response<String>()
Base64-encoded string representation of a JSON tuple representing [proof, claim]
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
09 }
10
11 // ⭐️Assuming user is logged in
12 fun generateIdToken(v: View) {
13 val configuration = GenerateIdTokenConfiguration(lifespan = 900, attachment = "none")
14 val completable = magic.user.generateIdToken(configuration)
15
16 completable.whenComplete { response: GenerateIdTokenResponse?, error: Throwable? ->
17 if (response != null) {
18 Log.d("Magic", response.result)
19 } else {
20 // handle Error
21 }
22 }
23 }
24}
#Associated Class
GenerateIdTokenConfiguration(attachment: String? = "none", lifespan: Long? = 900)
lifespan: will set the lifespan of the generated token. Defaults to 900s (15 mins)attachment: will set a signature of serialized data in the generated token. Defaults to"none"
#getMetadata
Retrieves information for the authenticated user.
#Public Methods
| Methods |
| getMetadata(): CompletableFuture<GetMetadataResponse> |
#Returns
GetMetadataResponse: Response<UserMetadataResponse>()
The Completable containing the issuer, email and cryptographic public address of the authenticated user.
01class UserMetadataResponse {
02 var issuer: String? = null
03 var publicAddress: String? = null
04 var email: String? = null
05}
issuer: The Decentralized ID of the user. In server-side use-cases, we recommend this value to be used as the user ID in your own tables.email: Email address of the authenticated user.publicAddress: The authenticated user's public address (a.k.a.: public key). Currently, this value is associated with the Ethereum blockchain.
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
09 }
10
11 // ⭐️Assuming user is logged in
12 fun getMetadata(v: View) {
13 val completable = magic.user.getMetadata()
14 completable.whenComplete { response: GetMetadataResponse?, error: Throwable? ->
15 if (response != null) {
16 Log.d("Magic", "Email: " + response.result.email)
17 Log.d("Magic", "Issuer: " + response.result.issuer)
18 } else {
19 // handle Error
20 }
21 }
22 }
23}
#isLoggedIn
Checks if a user is currently logged in to the Magic SDK.
#Public Methods
| Methods |
| isLoggedIn(): CompletableFuture<IsLoggedInResponse> |
#Returns
IsLoggedInResponse: Response<Boolean>()
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
09 }
10
11 // ⭐️ Assuming user is logged in
12 fun isLoggedIn(v: View) {
13 val completable = magic.user.isLoggedIn()
14 completable.whenComplete { response: IsLoggedInResponse?, error: Throwable? ->
15 if (response != null && response.result) {
16 Log.d("Magic", "You're Logged In")
17 }
18 if (error != null) {
19 // handle Error
20 }
21 }
22 }
23}
#logout
Logs out the currently authenticated Magic user
#Public Methods
| Methods |
| logout(): CompletableFuture<LogoutResponse> |
#Returns
LogoutResponse: Response<Boolean>()
#Example
01class MagicActivity: AppCompatActivity() {
02
03 lateinit var magic: Magic
04
05 override fun onCreate(savedInstanceState: Bundle?) {
06 super.onCreate(savedInstanceState)
07
08 magic = Magic(this, "YOUR_PUBLISHABLE_KEY")
09 }
10
11 // ⭐️Assuming user is logged in
12 fun logout(v: View) {
13 val completable = magic.user.logout()
14 completable.whenComplete { response: LogoutResponse?, error: Throwable? ->
15 if (response != null && response.result) {
16 Log.d("Magic", "You're logged out!")
17 }
18 if (error != null) {
19 // handle Error
20 }
21 }
22 }
23}
