Home Reference Source
public class | source

BaseAuthProvider

BaseAuthProvider provides example interface that an AuthProvider should provide.

To create an actual AuthProvider, you can extend the BaseAuthProvider and provide login, logout and info functions.

Example:

 class Provider extends skygearCloud.BaseAuthProvider {
   login(authData) {
     console.log(authData);
     // third-party API call
     return {
       principal_id: 'identifier',
       auth_data: {...}
     }
   }

   logout(authData) {
     console.log(authData);
   }

   info(authData) {
     console.log(authData);
   }
 }

Method Summary

Public Methods
public

async handleAction(action: *, param: *): *

public abstract

async info(authData: *)

this method must be overridden by subclass.

public abstract

async login(authData: *)

this method must be overridden by subclass.

public abstract

async logout(authData: *)

this method must be overridden by subclass.

Public Methods

public async handleAction(action: *, param: *): * source

Params:

NameTypeAttributeDescription
action *
param *

Return:

*

public abstract async info(authData: *) source

this method must be overridden by subclass.

Params:

NameTypeAttributeDescription
authData *

public abstract async login(authData: *) source

this method must be overridden by subclass.

Params:

NameTypeAttributeDescription
authData *

public abstract async logout(authData: *) source

this method must be overridden by subclass.

Params:

NameTypeAttributeDescription
authData *